.ENV GET ENV VARIABLE

This subroutine returns the value of a environment variable.

Usage:

      PASS         <env_value>                FIELD            SHARE? Y
      PASS         <env_name>                 FIELD            SHARE? N
      GOSUB    --- .ENV GET ENV VARIABLE
      *        Check for errors
      IF       --- .ENV GET ENV VARIABLE      NE

Description:

This subroutine returns the value of an environment variable. All parameters are required, if any are missing the subroutine will CANCEL.

<env_value> returns the value of the environment variable, if it found (Required). This must be PASSed with Share "Y" to return the value.

<env_name> is the name of the environment variable for which you want the value (Required).

If the field you passed is too short to contain the data, --- .ENV GET ENV VARIABLE will be set to "Data was truncated".

To get the value of a client constant, see .CLIENT GET CONSTANT.

Comments:

Read what other users have said about this page or add your own comments.

The list of environment variables that can be retrieved is quite long, and can vary by platform, installation, OS, etc. The correct name for each environment variable can be found in the Environment Variable Information screen off the Release Information option in System Administration, and can also be inferred from the Client Preferences pulldown on the client. Note that the variable names for client preferences are prefaced by 'client.pref.' followed by the option title in the Preferences display.

Some common uses for this subroutine would include retrieval of the following variables:

• APPXPATH
• client.clientHome
• client.file.separator
• client.pref.cachePath
• client.pref.dataCachePath
• client.pref.printCachePath
• client.pref.tokenCachePath
• client.pref.windowTitle

-- AlKalter - 2012-06-18

NOTE: To create an environment variable as part of a command line invocation of APPX, prepend two hyphens to the beginning of the variable name. For example, to run an APPX subroutine with a user name as an environment variable, the command line would look something like this:

/usr/local/appx/appx -d=DMO -a=DMO -t=SUBR -p=MY_SUBROUTINE --yourname="Fred Flintstone" 

Then, pass through yourname (without the hyphens) as the <env_name> value for this subroutine.

That same variable can also be retrieved using .GET CMD LINE PARM. For that API, though, the <param_name> variable would need to include the leading hyphens.

-- Al Kalter - 2016-10-17

-- JeanNeron - 2012-01-25