<Return[G]><Top>

GetEnvironmentVariable

Declare Function Api_GetEnvironmentVariable& Lib "kernel32" Alias "GetEnvironmentVariableA" (ByVal lpszName$, ByVal lpszValue$, ByVal cchValue&)

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

呼び出し側プロセスの環境ブロックから、指定された環境変数の値を取得する。この値は、NULL で終わる文字列である。

パラメータ
lpName
    環境変数の名前を保持している、NULL で終わる文字列を指定する。
lpBuffer
    1 個のバッファへのポインタを指定する。関数から制御が返ると、このバッファに、環境変数の値が格納される。
nSize
    lpBuffer パラメータが指すバッファのサイズを、TCHAR 単位で指定する。
 

戻り値
    関数が成功すると、lpBuffer バッファに格納された文字の数が TCHAR 単位で返る(終端の NULL 文字を除く)。
    指定された環境変数の名前が環境ブロック内に見つからなかった場合、0 が返る。
    lpBuffer パラメータが指すバッファのサイズが足りなかった場合、指定された環境変数の値を格納するために必要なバッファのサイズが、

    TCHAR 単位で返る(終端の NULL 文字を含む)。