My.Application.GetEnvironmentVariable メソッド
更新 : 2007 年 11 月
指定された環境変数の値を返します。
' Usage
Dim value As String = My.Application.GetEnvironmentVariable(name)
' Declaration
Public Function GetEnvironmentVariable( _
ByVal name As String _
) As String
パラメータ
- name
環境変数の名前を指定する String です。
戻り値
名前が name である環境変数の値を格納する String です。
例外
例外を引き起こす可能性のある状態を次に示します。
name 引数が Nothing です (ArgumentNullException)。
name で指定された環境変数が存在しません (ArgumentException)。
呼び出し元のコードに Read アクセスを持つ EnvironmentPermission がありません (SecurityException)。
解説
My.Application.GetEnvironmentVariable メソッドは、名前が name である環境変数を返します。このメソッドは Environment.GetEnvironmentVariable(String) と似ていますが、name で指定された環境変数が存在しない場合に例外を発生させる点が違います。
使用例
次の例は My.Application.GetEnvironmentVariable メソッドを使用し、PATH 環境変数の値を (取得できれば) 取得して表示します。取得できない場合は、PATH 環境変数が存在しないことを示すメッセージを表示します。
Private Sub TestGetEnvironmentVariable()
Try
MsgBox("PATH = " & My.Application.GetEnvironmentVariable("PATH"))
Catch ex As System.ArgumentException
MsgBox("Environment variable 'PATH' does not exist.")
End Try
End Sub
必要条件
名前空間 : Microsoft.VisualBasic.ApplicationServices
クラス : WindowsFormsApplicationBase、ApplicationBase
アセンブリ : Microsoft Visual Basic ランタイム (Microsoft.VisualBasic.dll 内)
使用可能なプロジェクトの種類
プロジェクトの種類 |
使用可/不可 |
---|---|
Windows アプリケーション |
可 |
クラス ライブラリ |
可 |
コンソール アプリケーション |
可 |
Windows コントロール ライブラリ |
可 |
Web コントロール ライブラリ |
不可 |
Windows サービス |
可 |
Web サイト |
不可 |
アクセス許可
アクセス許可は不要です。