Env_GetString

Description

Gets value of specified environment variable

 

Syntax

Env_GetString(sName, sType, bMustExist) As Boolean

 

Parameters

sName (String)

Environment variable name.

sType (String)

Environment variable type. 'System', 'User' or 'Process'

bMustExist (Boolean)

Environment variable must exist

 

Return value

Result will be stored in gsValue

 

Example

VBScript
If bStatus Then bStatus = Env_GetString("Path", "System", True)
If bStatus Then bStatus = Job_WriteLog("Custom", "gsValue: " & gsValue, bStatus, True)

Scripting Guidelines

 

Related functions

Env_SetString