Environ$関数

Environ$関数は、VBA関数の中でWindows・その他の関数に分類される関数です。

Environ$関数とは

Environ$関数は、オペレーティングシステムの環境変数に割り当てられた文字列型 (String) を返します。Macintosh では使用できません。

引数	省略	説明
構文	Environ$({envstring \| number})
envstring	●	環境変数の名前を表す文字列式を指定します。
number	●	環境文字列テーブルの中における環境文字列の順番を示す数式を指定します。名前付き引数 number には任意の数式を指定できますが、評価される前に整数に丸められます。

名前付き引数 envstring に指定した環境変数名が環境文字列テーブルに存在しない場合は、長さ 0 の文字列 (" ") が返されます。名前付き引数 envstring に指定した環境変数名が環境文字列テーブルに存在していれば、その環境変数に割り当てられた文字列 (環境文字列テーブルの中で、指定した環境変数の等号 (=) の後に記述されている文字列) が返されます。
名前付き引数 number に順番を指定すると、環境文字列テーブルの中でその順番に該当する文字列が返されます。この場合、名前付き引数 envstring を含むすべての文字列が返されます。該当する環境文字列が存在しなければ、長さ 0 の文字列 (" ") が返されます。

Environ$関数のサンプルコード

次の例は、Environ$ 関数を使って、環境文字列テーブルから環境変数 PATH のエントリ番号とバイト長を取得します。Macintosh では使用できません。


Sub Sample

Dim EnvString, Indx, Msg, PathLen        ' 変数を宣言します。
Indx = 1                                ' インデックスを 1 に設定します。
Do
    EnvString = Environ$(Indx)            ' 環境変数を取得します。
    If Left(EnvString, 5) = "PATH=" Then        ' 環境変数 PATH のエントリ番号を調べます。
        PathLen = Len(Environ$("PATH"))        ' バイト長を取得します。
        Msg = "PATH のｴﾝﾄﾘ番号は " & Indx & " 、長さは " & PathLen & "です。"
        Exit Do
    Else
        ' 見つからない場合は、インデックス (Indx) の値を増やします。
        Indx = Indx + 1、
    End If
Loop Until EnvString = ""
If PathLen > 0 Then
    MsgBox Msg                            ' メッセージを表示します。
Else
    MsgBox "環境変数 PATH が存在しません。"
End If

End Sub

実行結果

解説

Windows・その他の関数一覧

関数名	内容
Command	起動時に指定されたコマンドラインの引数を返します。
CreateObject	ActiveXオブジェクトへの参照を作成して返します。
DoEvents	VBAからWindowsにイベントの処理を依頼します。
Environ	OSの環境変数に割り当てられた名前を返します。
Environ$	指定した数番目の環境変数を返します。
GetAllSettings	アプリケーションの項目からすべてのキー設定に対応する値リストを返します。
GetObject	ファイルから取得したActiveXオブジェクトへの参照を返します。
GetSetting	アプリケーションの項目からキー設定値を返します。
IMEStatus	MS-IME(日本語入力システム)の現在の状態を返します。
QBColor	指定した番号に対応するRGBコードを返します。
RGB	RGBの値を色で指定します。
Shell	指定したプログラムを実行します。