Environmentクラス

Environment クラスは、このプロセスを実行している環境に関する情報を参照･設定したり環境に関する操作を行ったりするメソッドの集合です。

<Classes/System/Environment.ab>にて実装されています。

クラスの機能

公開メソッド

Exit

プロセスを終了します。

Static Sub Exit(exitCode As Long)

exitCode

オペレーティングシステムへ渡すプロセスの終了コードを指定します。

ExpandEnvironmentVariables

文字列中の環境変数を展開します。

Static Function ExpandEnvironmentVariables(s As String) As String

s

環境変数の指定を含んだ文字列

戻り値

展開後の文字列

環境変数は%NAME%のように%で環境変数名を挟んで指定します。

使用例

Dim s = System.Environment.ExpandEnvironmentVariables("%TEMP%\HOGE.$$$")

例えば環境変数TEMPの値がC:\WINDOWS\TEMPであれば、sの中身は、"C:\WINDOWS\TEMP\HOGE.$$$"になります。

FailFast

プロセスを強制的に終了します。

Static Sub FailFast(message As String)

message

ユーザへ通知するメッセージ

GetEnvironmentVariable

環境変数の値を返します。

Static Function GetEnvironmentVariable(variable As String) As String

variable

取得したい環境変数の名前

戻り値

それに対応する値

使用例

Dim s = System.Environment.GetEnvironmentVariable("%WINDIR%")

例えば環境変数WINDIRの値がC:\WINDOWSであれば、sの中身は、"C:\WINDOWS"になります（WINDOWSフォルダのパスを知りたければGetFolderPathメソッドを使用する方法もあります）。

GetFolderPath

特殊フォルダの絶対パスを返します。

Static Function GetFolderPath(f As Environment_SpecialFolder) As String

f

取得したい特殊フォルダを表すSpecialFolder列挙体の値

戻り値

対応する特殊フォルダへのパス

GetFolderPath関数 (ActiveBasic.Windows名前空間)は、取得可能な特殊フォルダの種類がこのメソッドの上位集合（スーパーセット）となっています。

SetEnvironmentVariable

環境変数を設定します。

Static Sub SetEnvironmentVariable(variable As String, value As String)

variable

環境変数の名前

value

設定する値

CommandLine

コマンドライン引数を返します。

Static Function CommandLine() As String

戻り値

コマンドライン引数

この戻り値は、空白などで分割された状態になっていません。必要なら自ら分解処理を行う必要があります。

公開プロパティ

CurrentDirectory

カレントディレクトリを参照･設定します。

Static Function CurrentDirectory() As String
Static Sub CurrentDirectory(cd As String)

ExitCode

終了コードを参照･設定します。

Static Function ExitCode() As Long
Static Sub ExitCode(code As Long)

Endステートメントを呼んだときにExitCodeの値がオペレーティングシステムへ渡されます。

HasShutdownStarted

プロセスが終了処理を開始しているかを参照します。

Static Function HasShutdownStarted() As Boolean

戻り値

終了処理が開始されている場合はTrueで、そうでなければFalse

終了処理が開始している場合、ライブラリの使用に制限が生じる可能性があります。

MachineName

プロセスを実行中のコンピュータの名前を参照します。

Static Function MachineName() As String

NewLine

現在実行しているシステムの標準の改行文字列を参照します。

Static Function NewLine() As String

WindowsではEx"\r\n"です。

OSVersion

プロセスを実行中のオペレーティングシステムのバージョン情報を参照します。

Static Function OSVersion() As OperatingSystem

戻り値

実行中のオペレーティングシステムのバージョン情報を表すOperatingSystem クラスのインスタンス

ProcessorCount

実行中のコンピュータが搭載しているプロセッサの数を参照します。

Static Function ProcessorCount() As Long

SystemDirectory

システムディレクトリの絶対パスを返します。

Static Function SystemDirectory() As String

システムディレクトリは、例えばC:\WINDOWS\SYSTEM (9x, 2000以降)やC:\WINNT\SYSTEM32 (NT 4まで)などのようになります。

TickCount

システムが起動してからの時間をミリ秒単位で参照できます。

Static Function TickCount() As Long

戻り値

システムが起動してからの時間（ミリ秒単位）

UserName

このプロセスを実行しているユーザの名前を参照します。

Static Function UserName() As String

戻り値

ユーザ名

WorkingSet

ワーキングセット（プロセスに割り当てられている物理メモリ量）を参照します

Static Function WorkingSet() As Int64

戻り値

ワーキングセットの量

なお、このメソッドはWindows NT系以外では利用できません。利用不可能な環境では0が戻り値となります。

公開列挙体

SpecialFolder

GetFolderPathメソッドで特殊フォルダを指定するための列挙体です。現在、クラス内に列挙体を宣言できないため、暫定処置としてSystem名前空間上にEnvironment_SpecialFolderとして存在させています。

Desktop

仮想デスクトップ（ユーザ毎） - このフォルダへのパスは取得できません。DesktopDirectoryを用いてください。

DesktopDirectory

ファイルシステム上のデスクトップディレクトリ（Windows 2000/XPでは主にC:\Documents And Settings\ユーザ名\Desktopになります）

MyComputer

マイコンピュータ - このフォルダへのパスは取得できません。

Personal

マイドキュメント

MyDocuments

マイドキュメント

MyPictures

マイピクチャ

MyMusic

マイミュージック

StartMenu

スタートメニュー（ユーザ毎）

Programs

スタートメニューまたはプログラムグループのプログラム

Startup

スタートアップ（ユーザ毎）

Recent

最近使ったファイル

SendTo

送る

Templates

ドキュメントテンプレート

Favorites

お気に入り

InternetCache

インターネットキャッシュ

Cookies

インターネットクッキー

History

履歴

ApplicationData

アプリケーションデータ

LocalApplicationData

このコンピュータに固有のアプリケーションデータ

CommonApplicationData

アプリケーションデータ（全ユーザ共通）

System

システムディレクトリ

CommonProgramFiles

Program Files（全ユーザ共通）

ProgramFiles

プログラムファイル（主にC:\Program Filesでしょう）