Interaction.Environ メソッド

定義

名前空間:
Microsoft.VisualBasic
アセンブリ:
Microsoft.VisualBasic.dll

オペレーティング システム環境変数に関連付けられている文字列を返します。

オーバーロード

名前 説明
Environ(String)

オペレーティング システム環境変数に関連付けられている文字列を返します。
Environ(Int32)

オペレーティング システム環境変数に関連付けられている文字列を返します。

Environ(String)

オペレーティング システム環境変数に関連付けられている文字列を返します。

public:
 static System::String ^ Environ(System::String ^ Expression);
public static string Environ(string Expression);
static member Environ : string -> string
Public Function Environ (Expression As String) As String

パラメーター

Expression
String

必須。 環境変数の名前を含む文字列、または環境文字列テーブル内の環境文字列の数値の順序に対応する整数を評価する式。

返品

String

オペレーティング システム環境変数に関連付けられている文字列。

例外

ArgumentException

Expression が見つかりません。

例

この例では、 Environ 関数を使用して、環境文字列テーブルから PATH ステートメントのエントリ番号と長さを指定します。

Sub tenv()
    Dim envString As String
    Dim found As Boolean = False
    Dim index As Integer = 1
    Dim pathLength As Integer
    Dim message As String

    envString = Environ(index)
    While Not found And (envString <> "")
        If (envString.Substring(0, 5) = "Path=") Then
            found = True
        Else
            index += 1
            envString = Environ(index)
        End If
    End While

    If found Then
        pathLength = Environ("PATH").Length
        message = "PATH entry = " & index & " and length = " & pathLength
    Else
        message = "No PATH environment variable exists."
    End If

    MsgBox(message)
End Sub

注釈

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

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

Important

Environ関数には環境のアクセス許可が必要です。これは、部分信頼の状況での実行に影響する可能性があります。 詳細については、「 SecurityPermission および コード アクセス許可」を参照してください。

こちらもご覧ください

適用対象

Environ(Int32)

オペレーティング システム環境変数に関連付けられている文字列を返します。

public:
 static System::String ^ Environ(int Expression);
public static string Environ(int Expression);
static member Environ : int -> string
Public Function Environ (Expression As Integer) As String

パラメーター

Expression
Int32

必須。 環境変数の名前を含む文字列、または環境文字列テーブル内の環境文字列の数値の順序に対応する整数を評価する式。

返品

String

オペレーティング システム環境変数に関連付けられている文字列。

例外

ArgumentException

Expression が見つかりません。

例

この例では、 Environ 関数を使用して、環境文字列テーブルから PATH ステートメントのエントリ番号と長さを指定します。

Sub tenv()
    Dim envString As String
    Dim found As Boolean = False
    Dim index As Integer = 1
    Dim pathLength As Integer
    Dim message As String

    envString = Environ(index)
    While Not found And (envString <> "")
        If (envString.Substring(0, 5) = "Path=") Then
            found = True
        Else
            index += 1
            envString = Environ(index)
        End If
    End While

    If found Then
        pathLength = Environ("PATH").Length
        message = "PATH entry = " & index & " and length = " & pathLength
    Else
        message = "No PATH environment variable exists."
    End If

    MsgBox(message)
End Sub

注釈

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

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

Important

Environ関数には環境のアクセス許可が必要です。これは、部分信頼の状況での実行に影響する可能性があります。 詳細については、「 SecurityPermission および コード アクセス許可」を参照してください。

こちらもご覧ください

適用対象