FPUTENV: Assigning a Value to an Environment Variable

How to:

The FPUTENV function assigns a character string to an operating system environment variable.

Limit: You cannot use FPUTENV to set or change FOCPRINT, FOCPATH, or USERPATH. Once started, these variables are held in memory and will not be re-read from the environment even if you change it.


Top of page

x
Syntax: How to Assign Value to an Environment Variable
FPUTENV(varname_length, varname, value_length, value, output_format)

where:

varname_length

Integer

Is the number of characters in the environment variable, varname.

varname

Alphanumeric

Is the name of the environment variable. The name must be right-justified and padded with blanks to the maximum length specified by varname_length.

value_length

Alphanumeric

Is the maximum length of the environment variable value.

value

Alphanumeric

Is the value you want to assign to the environment variable, varname.

output_format

Integer

Is the return code. If varname is set successfully, the return code is 0. Any other value indicates that a failure occurred.

Note: The sum of varname_length and value_length cannot exceed 64 characters.



Example: Assigning a Value to an Environment Variable

FPUTENV assigns the value FOCUS/Shell to the PS1 variable and stores it in a column with the format A12.

FPUTENV(3,'PS1', 12 'FOCUS/Shell:', 'A12')

The request displays the following prompt when the user issues the UNIX shell command SH:

FOCUS/Shell:

iWay Software