ENVINT() and envintc()

Fortran version:

ENVINT() is a Fortran wrapper calling the C envintc()

    INTEGER FUNCTION ENVINT( LNAME, DESCRIP, DEFAULT, STATUS )
        CHARACTER*(*)   LNAME   ! logical name to evaluate
        CHARACTER*(*)   DESCRIP ! description of the value
        INTEGER         DEFAULT ! default value (if LNAME not set, or empty)
        INTEGER         STATUS  ! for distinguishing default/error cases

C version:

int envintc( const char * lname       , 
             const char * description , 
             int          defaultval  ,
             int        * status )

Summary:

This function is a shell around the getenv() system call: find, log, and return the value of shell variable/logical name LNAME in the environment , and interpret it as an integer. Returns the DEFAULT if the logical name is not defined, is defined but has an empty value, or has an improper value. Writes a message to the log indicating the value returned -- and if the value was improper, writes a warning notice. STATUS takes the following values:

For Fortran-90 declarations and interface checking:

    USE M3UTILIO
    

See also

ENVDBLE,
ENVREAL,
ENVSTR,
ENVYN,
NAMEVAL, and
SETENVVAR.

Preconditions:

#include "iodecl3.h" if called from C.

LNAME and DESCRIP have length at most 256. (NOTE: POSIX says that environment variables may have lengths this long.)

Fortran Usage:

Get a program-control parameter for logical name 'FOO' which defaults to 17, generating appropriate log messages, etc.:
...
setenv FOO 23
...
/mydirectory/myprogram
... 
    ...
    INTEGER        FOO
    INTEGER        STATUS
    ...
    FOO = ENVINT( 'FOO', 
 &             'Some control parameter or other, called FOO',
 &             17 ,
 &             STATUS )
    IF ( STATUS .GT. 0 ) THEN
        ... bad value for FOO; do something.
    END IF
    ...

C Usage:

Same as above, but test for different kinds of defaults as well:
#include "iodecl3.h"
...
int   status, value ;
...
value =  envintc( "FOO", 
                 "Here is where I put a description",
                 17 ,
                 & status ) )
if ( status  0 ) 
    {
    ... stuff for bad (non-integer) value of environment variable FOO
    }
else if ( status == -1 ) 
    {
    ... stuff for empty-but-defined FOO
    }
else if ( status == -2 ) 
    {
    ... stuff for not-defined-at-all FOO
    }
... 
use value...


Previous: ENVDBLE

Next: ENVREAL

Up: Utility Routines

To: Models-3/EDSS I/O API: The Help Pages