ssCore.SysInfo.getEnv

Provides access to operating system environment variables, like PATH.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

variable - Name of the environment variable to retrieve.


Output Parameters:

result - The value assigned to the specified environment variable. The condition code will be set to indicate an error and an empty string will be returned if the environment variable does not exist.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.SysInfo.getEnv( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.SysInfo.getEnv( paramsObject );


Notes:

None.


Examples:

var return_obj = ssCore.SysInfo.getEnv({variable:"TEMP"});

ssDebug.trace(return_obj.result);