GETENVVAR method (System) [Revelation On-Line Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

====== GETENVVAR method (System) ======


 
==== Description ====
 
 
This method returns the value of a Windows environment variable.
 
 
 
 
==== Syntax ====
 
 
EnvVarValue = Exec_Method( "SYSTEM", "GETENVVAR", EnvVarName )
 
 
 
 
==== Parameters ====
 
 
 
^Name^Required^Description^
|EnvVarValue|Yes|Name of the environment variable to query.|

 


 
==== Returns ====
 
 
The value of the specified Windows environment variable.
 
 
 
 
==== Remarks ====
 
 
This method is a simple wrapper around the Windows API GetEnvironmentVariable function - further information regarding Windows environment variables may be found on the MSDN website.
 
 
 
 
 
 
==== Example ====
 
<code>
 
// Get the value of the Windows "SystemDrive" variable

  

  SessionName = Exec_Method( "SYSTEM", "GETENVVAR", "SystemDrive" )
 
 
 

</code>

 
==== See Also ====
 
 
SETENVVAR method, ENVVARLIST property