Function name: GetEnvironmentVariable

Defined in : Kernel32

Requirements : Windows NT 3.1 or later; Windows 95 or later

Declaration:

Declare Function GetEnvironmentVariable Lib "kernel32" Alias "GetEnvironmentVariableA" (ByVal lpName As String, ByVal lpBuffer As String, ByVal nSize As Long) As Long

Parameters:

* lpName [in] Pointer to a null-terminated string that specifies the environment variable. * lpBuffer [out] Pointer to a buffer to receive the value of the specified environment variable. * nSize [in] Specifies the size, in TCHARs, of the buffer pointed to by the lpBuffer parameter.

Returns:

If the function succeeds, the return value is the number of characters stored into the buffer pointed to by lpBuffer, not including the terminating null character. If the specified environment variable name was not found in the environment block for the current process, the return value is zero. If the buffer pointed to by lpBuffer is not large enough, the return value is the buffer size, in characters, required to hold the value string and its terminating null character.

Related functions:

Examples:

Sorry, this function has no examples yet.