GET_ENVIRONMENT_VARIABLE — Get an environmental variable#
-
GET_ENVIRONMENT_VARIABLE(NAME, VALUE, LENGTH, STATUS, TRIM_NAME)#
Get the
VALUE
of the environmental variableNAME
.- Parameters
NAME – Shall be a scalar of type
CHARACTER
and of default kind.VALUE – (Optional) Shall be a scalar of type
CHARACTER
and of default kind.LENGTH – (Optional) Shall be a scalar of type
INTEGER
and of default kind.STATUS – (Optional) Shall be a scalar of type
INTEGER
and of default kind.TRIM_NAME – (Optional) Shall be a scalar of type
LOGICAL
and of default kind.
- Returns
Stores the value of
NAME
inVALUE
. IfVALUE
is not large enough to hold the data, it is truncated. IfNAME
is not set,VALUE
will be filled with blanks. ArgumentLENGTH
contains the length needed for storing the environment variableNAME
or zero if it is not present.STATUS
is -1 ifVALUE
is present but too short for the environment variable; it is 1 if the environment variable does not exist and 2 if the processor does not support environment variables; in all other casesSTATUS
is zero. IfTRIM_NAME
is present with the value.FALSE.
, the trailing blanks inNAME
are significant; otherwise they are not part of the environment variable name.
- Standard:
Fortran 2003 and later
- Class:
Subroutine
- Syntax:
CALL GET_ENVIRONMENT_VARIABLE(NAME[, VALUE, LENGTH, STATUS, TRIM_NAME)
- Example:
PROGRAM test_getenv CHARACTER(len=255) :: homedir CALL get_environment_variable("HOME", homedir) WRITE (*,*) TRIM(homedir) END PROGRAM