「Environmentクラス」の版間の差分

提供: AB開発Wiki
ナビゲーションに移動検索に移動
 
(全てのメンバを記述)
1行目: 1行目:
'''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メソッド]]を使用する方法もあります)。
 +
 
 +
====GetFolderPath====
 +
特殊フォルダの絶対パスを返します。
 +
Static Function GetFolderPath(f As Environment_SpecialFolder) As String
 +
;f
 +
:取得したい特殊フォルダを表す[[#SpecialFolder|SpecialFolder列挙体]]の値
 +
;戻り値
 +
:対応する特殊フォルダへのパス
 +
[[GetFolderPath 関数]] (ActiveBasic.Windows名前空間)は、取得可能な特殊フォルダの種類がこのメソッドの上位集合(スーパーセット)となっています。
 +
 
 +
====SetEnvironmentVariable====
 +
環境変数を設定します。
 +
Static Sub SetEnvironmentVariable(variable As String, value As String)
 +
;variable
 +
:環境変数の名前
 +
;value
 +
:設定する値
 +
 
 
====CommandLine====
 
====CommandLine====
  Static Function CommandLine() As [[String クラス|String]]
+
コマンドライン引数を返します。
このプロセス用のコマンドラインを取得します。
+
  Static Function CommandLine() As String
 +
;戻り値
 +
:コマンドライン引数
 +
この戻り値は、空白などで分割された状態になっていません。必要なら自ら分解処理を行う必要があります。
 +
 
 +
===公開プロパティ===
 
====CurrentDirectory====
 
====CurrentDirectory====
  Static Function CurrentDirectory() As [[String クラス|String]]
+
カレントディレクトリを参照・設定します。
  Static Sub CurrentDirectory(cd As [[String クラス|String]])
+
  Static Function CurrentDirectory() As String
カレントディレクトリの取得または設定をします。
+
  Static Sub CurrentDirectory(cd As String)
 +
 
 
====ExitCode====
 
====ExitCode====
 +
終了コードを参照・設定します。
 
  Static Function ExitCode() As Long
 
  Static Function ExitCode() As Long
 
  Static Sub ExitCode(code As Long)
 
  Static Sub ExitCode(code As Long)
プロセスの終了コードを取得または設定します。
+
[[End ステートメント]]を呼んだときにExitCodeの値がオペレーティングシステムへ渡されます。
 +
 
 
====HasShutdownStarted====
 
====HasShutdownStarted====
 +
プロセスが終了処理を開始しているかを参照します。
 
  Static Function HasShutdownStarted() As Boolean
 
  Static Function HasShutdownStarted() As Boolean
 +
;戻り値
 +
:終了処理が開始されている場合はTrueで、そうでなければFalse
 +
終了処理が開始している場合、ライブラリの使用に制限が生じる可能性があります。
  
 
====MachineName====
 
====MachineName====
  Static Function MachineName() As [[String クラス|String]]
+
プロセスを実行中のコンピュータの名前を参照します。
コンピュータの名前を取得します。
+
  Static Function MachineName() As String
 +
 
 
====NewLine====
 
====NewLine====
  Static Function NewLine() As [[String クラス|String]]
+
現在実行しているシステムの標準の改行文字列を参照します。
この環境で使われている改行コードを取得します。
+
  Static Function NewLine() As String
 +
WindowsではEx"\r\n"です。
 +
 
 
====OSVersion====
 
====OSVersion====
 +
プロセスを実行中のオペレーティングシステムのバージョン情報を参照します。
 
  Static Function OSVersion() As [[OperatingSystem クラス|OperatingSystem]]
 
  Static Function OSVersion() As [[OperatingSystem クラス|OperatingSystem]]
現在のプラットフォームIDとバージョン番号を格納している[[OperatingSystem クラス|OperatingSystem]]オブジェクトを取得します。
+
;戻り値
====rocessorCount====
+
:実行中のオペレーティングシステムのバージョン情報を表す[[OperatingSystem クラス]]のインスタンス
 +
 
 +
====ProcessorCount====
 +
実行中のコンピュータが搭載しているプロセッサの数を参照します。
 
  Static Function ProcessorCount() As Long
 
  Static Function ProcessorCount() As Long
現在のコンピュータのプロセッサ数を取得します。
+
 
 
====SystemDirectory====
 
====SystemDirectory====
  Static Function SystemDirectory() As [[String クラス|String]]
+
システムディレクトリの絶対パスを返します。
システムディレクトリの絶対パスを取得します。
+
  Static Function SystemDirectory() As String
 +
システムディレクトリは、例えばC:\WINDOWS\SYSTEM (9x)やC:\WINNT\SYSTEM32 (NT)などのようになります。
 +
 
 
====TickCount====
 
====TickCount====
 +
システムが起動してからの時間をミリ秒単位で参照できます。
 
  Static Function TickCount() As Long
 
  Static Function TickCount() As Long
コンピュータが起動してからの時間を、ミリ秒単位で取得します。
+
;戻り値
 +
:システムが起動してからの時間(ミリ秒単位)
 +
 
 
====UserName====
 
====UserName====
  Static Function UserName() As [[String クラス|String]]
+
このプロセスを実行しているユーザの名前を参照します。
スレッドを開始したユーザー名を取得します。
+
  Static Function UserName() As String
 +
;戻り値
 +
:ユーザ名
 +
 
 
====WorkingSet====
 
====WorkingSet====
  Static Function WorkingSet() As Int64
+
ワーキングセット(プロセスに割り当てられている物理メモリ量)を参照します
プロセスコンテキストに割り当てられる物理メモリ量を取得します。※NT系OSのみ
+
Static Function WorkingSet() As Int64
===公開メソッド===
+
;戻り値
====Exit====
+
:ワーキングセットの量
Static Sub Exit(exitCode As Long)
+
なお、このメソッドはWindows NT系以外では利用できません。利用不可能な環境では0が戻り値となります。
;exitCode
 
:プロセスの終了コードを指定します。
 
このプロセスを終了し、exitCodeで指定した終了コードをオペレーティングシステムに渡します。
 
====ExpandEnvironmentVariables====
 
Static Function ExpandEnvironmentVariables(s As [[String クラス|String]]) As  [[String クラス|String]]
 
;s
 
:環境変数が含まれる文字列を指定します。
 
指定した文字列に含まれる環境変数の名前を、その変数の値で置き換えた文字列を取得します。
 
====FailFast====
 
Static Sub FailFast(message As [[String クラス|String]])
 
  
====GetEnvironmentVariable====
+
===公開列挙体===
Static Function GetEnvironmentVariable(variable As [[String クラス|String]]) As [[String クラス|String]]
+
====SpecialFolder====
;variable
+
[[#GetFolderPath|GetFolderPathメソッド]]で特殊フォルダを指定するための列挙体です。現在、クラス内に列挙体を宣言できないため暫定処置としてSystem名前空間上にEnvironment_SpecialFolderとして存在させています。
:環境変数名を指定します。
+
;Desktop
指定した名前の、現在のプロセスの環境変数を取得します。
+
:仮想デスクトップ(ユーザ毎) - このフォルダへのパスは取得できません。DesktopDirectoryを用いてください。
====GetFolderPath====
+
;DesktopDirectory
Static Function GetFolderPath(f As [[Environment.SpecialFolder 列挙体|Environment_SpecialFolder]]) As  [[String クラス|String]]
+
:ファイルシステム上のデスクトップディレクトリ(Windows 2000/XPでは主にC:\Documents And Settings\''ユーザ名''\Desktopになります)
;f
+
;MyComputer
:[[Environment.SpecialFolder 列挙体|Environment_SpecialFolder 列挙体]]を指定します。
+
:マイコンピュータ - このフォルダへのパスは取得できません。
指定した列挙体で識別される、システム固有のフォルダへのパスを取得します。
+
;Personal
====SetEnvironmentVariable====
+
:マイドキュメント
現在のプロセスの環境変数の作成、変更、削除を行います。
+
;MyDocuments
Static Sub SetEnvironmentVariable(variable As [[String クラス|String]], value As [[String クラス|String]])
+
:マイドキュメント
;variable
+
;MyPictures
:環境変数名を指定します。
+
:マイピクチャ
;value
+
;MyMusic
:値を指定します。
+
:マイミュージック
variableの環境変数を、valueの値で設定します。variableで指定した環境変数が存在しない場合、その環境変数を作成します。また、既に存在する名前の環境変数をvariableで指定し、valueに空の値を設定することにより、その環境変数を削除することができます。
+
;StartMenu
 +
:スタートメニュー(ユーザ毎)
 +
;Programs
 +
:スタートメニューまたはプログラムグループのプログラム
 +
;Startup
 +
:スタートアップ(ユーザ毎)
 +
;Recent
 +
:最近使ったファイル
 +
;SendTo
 +
:送る
 +
;Templates
 +
:ドキュメントテンプレート
 +
;Favorites
 +
:お気に入り
 +
;InternetCache
 +
:インターネットキャッシュ
 +
;Cookies
 +
:インターネットクッキー
 +
;History
 +
:履歴
 +
;ApplicationData
 +
:アプリケーションデータ
 +
;LocalApplicationData
 +
:このコンピュータに固有のアプリケーションデータ
 +
;CommonApplicationData
 +
:アプリケーションデータ(全ユーザ共通)
 +
;System
 +
:システムディレクトリ
 +
;CommonProgramFiles
 +
:Program Files(全ユーザ共通)
 +
;ProgramFiles
 +
:プログラムファイル(主にC:\Program Filesでしょう)
  
 
[[Category:System 名前空間]]
 
[[Category:System 名前空間]]

2007年6月9日 (土) 15:40時点における版

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)やC:\WINNT\SYSTEM32 (NT)などのようになります。

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でしょう)