%SetEnvStr function

Function

The function sets given value of specified environmental variable.

Declaration

TEXT %SetEnvStr(
    TEXT in envVarName 
    TEXT in envVarValue
 )

Parameters

envVarName	Name of an environmental variable.
envVarValue	Value of the environmental variable.

Description

The function sets the given value of the environmental variable. If the variable doesn't exist, the function creates it. Changes of environmental variable value are local and within the process that calls the function.

Return value

The function always returns @TRUE.

Example

BOOL  _b
 TEXT _v 
 
 ; setting the value of the environmental variable
 _b := %SetEnvStr("TEST", "VALUE") 

 ; retrieving the value of the variable
 _v := %GetEnvStr("TEST")  ; value of the variable is to be "VALUE"