Environ 関数

適用先
Access for Microsoft 365 Access 2024 Access 2021 Access 2019 Access 2016

注

Microsoft Jet Expression Service がサンドボックス モードで実行されている場合 (安全でない可能性がある式の評価は行われません)、このトピックで説明する関数、メソッド、オブジェクト、またはプロパティは無効です。 サンドボックス モードの詳細については、ヘルプで "サンドボックス モード" を検索してください。

オペレーティング システムの環境変数に関連付けられている String を返します。 Macintosh では利用できません。

構文

Environ( { envstring | number } )

Environ 関数の引数は次のとおりです。

引数 説明
envstring 省略可能。 環境変数の名前を含む文字列式。
number 省略可能。 環境文字列テーブル内での環境文字列の数値順序に対応する数値式。 number 引数には任意の数値式を指定できますが、評価される前に整数に丸められます。

    

解説

環境文字列テーブルに envstring が見つからない場合は、長さ 0 の文字列 ("") が返されます。 それ以外の場合、 Environ は指定された envstring に割り当てられたテキストを返します。つまり、その環境変数の環境文字列テーブルの等号 (=) に続くテキストです。

number を指定すると、環境文字列テーブル内のその数値位置を占める文字列が返されます。 この場合、 Environ は envstring を含むすべてのテキストを返します。 指定した位置に環境文字列がない場合、Environ は長さ 0 の文字列を返します。

例

注

次の例は、Visual Basic for Applications (VBA) モジュールでのこの関数の使用方法を示しています。 VBA の使用方法の詳細については、[検索] の横にあるドロップダウン リストで [開発者用リファレンス] を選び、検索ボックスに検索する用語を入力します。

この例では 、Environ 関数を使用して、environment-string テーブルから PATH ステートメントのエントリ番号と長さを指定します。 Macintosh では使用できません。

Dim EnvString, Indx, Msg, PathLen    ' Declare variables.
Indx = 1    ' Initialize index to 1.
Do
    ' Get environment variable.
    EnvString = Environ(Indx)
    ' Check PATH entry.
    If Left(EnvString, 5) = "PATH=" Then
        ' Get length.
        PathLen = Len(Environ("PATH"))
        Msg = "PATH entry = " & Indx & " and length = " _
               & PathLen
        Exit Do
    Else
        ' Not PATH entry, so increment.
        Indx = Indx + 1
    End If
Loop Until EnvString = ""
If PathLen > 0 Then
    ' Display message.
    MsgBox Msg
Else
    MsgBox "No PATH environment variable exists."
End If