Environ 関数

  • [アーティクル]

更新 : 2007 年 11 月

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

Overloads Function Environ(ByVal Expression As Integer) As String
' -or-
Overloads Function Environ(ByVal Expression As String) As String

パラメータ

  • Expression
    必ず指定します。環境変数名を含む文字列か、または環境ストリング テーブルでの環境文字列の番号に対応する整数のどちらかを指す式を指定します。

例外

例外の種類

エラー番号

条件

ArgumentException

5

Expression が指定されていません。

非構造化エラー処理を使用する Visual Basic 6.0 アプリケーションをアップグレードする場合は、"エラー番号" の列を参照してください(エラー番号を Number プロパティ (Err オブジェクト) と比較することもできます)。ただし、可能であれば、このようなエラー制御は Visual Basic の構造化例外処理の概要 に置き換えることを検討してください。

解説

引数 Expression に文字列が含まれる場合、Environ 関数は、指定された環境文字列に設定されたテキストを返します。これは、該当する環境変数の環境ストリング テーブルで、等号 (=) の後に続くテキストです。引数 Expression 内の文字列が環境ストリング テーブルに見つからない場合は、長さ 0 の文字列 ("") が返されます。

引数 Expression に整数が含まれる場合は、環境ストリング テーブルでその数値が示す位置にある文字列が返されます。この場合、Environ 関数は、環境変数名を含むテキスト全体を返します。指定された位置に環境文字列がない場合、Environ 関数は長さ 0 の文字列を返します。

0fx287h4.alert_security(ja-jp,VS.90).gifセキュリティに関するメモ :

Environ 関数には環境変数へのアクセス許可が必要です。ただし、部分的に信頼されている状況でこの許可を使用すると、プログラムの実行に影響を及ぼす場合があります。詳細については、「SecurityPermission」および「コード アクセス許可」を参照してください。

使用例

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

スマート デバイス開発者のためのメモ

この関数はサポートされていません。

必要条件

名前空間 : Microsoft.VisualBasic

モジュール : Interaction

アセンブリ : Visual Basic ランタイム ライブラリ (Microsoft.VisualBasic.dll)

参照

参照

Visual Basic ランタイム ライブラリのメンバ

ArgumentException