OpenVMS マニュアル

DCL コマンド環境に関する情報を戻します。

形式

F$ENVIRONMENT (項目)

戻り値

引数

項目

戻される情報のタイプを指定します。次に示すキーワードのいずれか 1 つを指定します ( キーワードを短縮することはできません )。

項目	データ・タイプ	戻される情報
CAPTIVE	文字列	CAPTIVE 属性を持ったアカウントにログインしている場合は，TRUE を戻します。システム管理者は，Authorize ユーティリティ (AUTHORIZE) を使用して，利用者登録ファイルにも CAPTIVE アカウントを定義できます。
CONTROL	文字列	SET CONTROL コマンドによって現在使用可能になっている制御文字を戻します。複数の制御文字が使用可能な場合には，各文字はコンマで区切られます。制御文字が使用可能ではない場合には，空文字列 ("") が戻されます。
DEFAULT	文字列	現在の省略時の装置，およびディレクトリ名を戻します。戻される文字列は SHOW DEFAULT コマンドにより出力される文字列と同じです。
DEPTH	整数値	現在のコマンド・プロシージャのネスティングの中での深さを，整数として戻します。会話型でコマンド・プロシージャを実行する場合，およびバッチ・ジョブでコマンド・プロシージャを実行する場合，コマンド・プロシージャの深さは 0 です。ネスティングされたコマンド・プロシージャの深さは，そのネスティングされたプロシージャを実行したコマンド・プロシージャの深さより，1 だけ大きな値です。
DISIMAGE	文字列	イメージを直接起動することが許可されていないアカウント ( たとえば RUN などは許可されていません ) にログインした場合， TRUE を戻します。システム管理者は Authorize ユーティリティを使用して，利用者登録ファイル内のアカウントに DISIMAGE 属性を追加または削除できます。
INTERACTIVE	文字列	プロセスが会話型で実行されている場合は，TRUE を戻します。
KEY_STATE	文字列	現在ロックされているキーパッド状態を示す文字列を戻します。キーパッド状態についての詳細は，DEFINE/KEY コマンドの説明を参照してください。
MAX_DEPTH	整数値	コマンド・プロシージャの最大の深さを示す整数を戻します。
MESSAGE	文字列	SET MESSAGE コマンドによる現在の設定を示す文字列を戻します。この文字列には，修飾子名を区切るために，スラッシュ(/) が含まれています。したがって，F$ENVIRONMENT("MESSAGE") からの出力を， SET MESSAGE コマンドのうしろに追加することにより，有効な DCL コマンド行を作成できます。
NOCONTROL	文字列	SET NOCONTROL コマンドによって，現在禁止されている制御文字を戻します。複数の文字が禁止されている場合には，各文字はコンマ (,) で区切られます。SET NOCONTROL コマンドによって制御文字が禁止されていない場合には，空文字列が戻されます。
ON_CONTROL_Y	文字列	コマンド・プロシージャから実行される場合は， ON_CONTROL_Y が設定されていれば TRUE を戻します。 DCL コマンド・レベルでは，ON_CONTROL_Y は常に FALSE を戻します。
ON_SEVERITY	文字列	コマンド・プロシージャから実行される場合は， ON コマンドで指定した動作が実行される重要度を戻します。 SET NOON が有効な場合，または DCL コマンド・レベルで使用した場合， ON_SEVERITY は NONE を戻します。
OUTPUT_RATE	文字列	省略時の出力速度を含むデルタ時間文字列を戻します。これは，バッチ・ジョブの実行中に，バッチ・ジョブ・ログ・ファイルにデータが書き込まれる頻度を示します。会話型で使用した場合，OUTPUT_RATE は空文字列を戻します。
PROCEDURE	文字列	現在のコマンド・プロシージャのファイル指定を戻します。会話型で使用した場合は，端末装置名が戻されます。
PROMPT	文字列	現在の DCL プロンプトを戻します。
PROMPT_CONTROL	文字列	プロンプトの前に改行が挿入される場合は TRUE を戻します。
PROTECTION	文字列	現在の省略時のファイル保護を示す文字列を戻します。文字列は有効な DCL コマンド行となるように， SET PROTECTION/DEFAULT コマンドで使用できる形式です。
RESTRICTED	文字列	制限付アカウントの場合は TRUE を戻します。システム管理者は，Authorize ユーティリティを使用して，利用者登録ファイルに制限付アカウントを定義できます。
SYMBOL_SCOPE	文字列	現在のシンボルの定義範囲を示すため，文字列 [NO] LOCAL, [NO] GLOBALを戻します。
VERB_SCOPE	文字列	動詞の現在のシンボルの定義範囲を示すため，文字列 [NO] LOCAL, [NO] GLOBAL を戻します ( 詳細は， SET SYMBOL コマンドの説明を参照してください )。
VERIFY_IMAGE	文字列	SET VERIFY=IMAGE コマンドが有効である場合は，TRUE を戻します。イメージ・チェックが有効な場合には，コマンド・プロシージャは，イメージによって読み込まれた入力データを表示します。
VERIFY_PREFIX	文字列	SET PREFIX コマンドで設定される前置制御文字列を戻します。
VERIFY_PROCEDURE	文字列	SET VERIFY=PROCEDURE コマンドが有効である場合は，TRUE を戻します。コマンド・チェックが有効な場合には，コマンド・プロシージャは， DCL コマンド行を表示します。

例

$ SAVE_MESSAGE = F$ENVIRONMENT("MESSAGE")
$ SET MESSAGE/NOFACILITY/NOIDENTIFICATION
   .
   .
   .
$ SET MESSAGE'SAVE_MESSAGE'
 

この例では，F$ENVIRONMENT 関数を使用して，現在のメッセージ設定を変更する前に，その設定を保存します。コマンド・プロシージャの最後で，もとのメッセージ設定が復元されます。SAVE_MESSAGE というシンボルを囲む一重引用符 (' ') は，そのシンボル名を値と置き換えるように指定しています。

$ MAX = F$ENVIRONMENT("MAX_DEPTH")
$ SHOW SYMBOL MAX
  MAX = 32   Hex = 00000020  Octal = 00000000040
 

この例では，コマンド・プロシージャ内で可能な最大のネスティングの深さを判断するために，F$ENVIRONMENT 関数を使用しています。

$ SAVE_PROT = F$ENVIRONMENT("PROTECTION")
$ SET PROTECTION = (SYSTEM:RWED, OWNER:RWED, GROUP, WORLD)/DEFAULT
   .
   .
   .
$ SET PROTECTION = ('SAVE_PROT')/DEFAULT
 

この例では，F$ENVIRONMENT 関数を使用して，保護を変更する前に，現在の省略時の保護を保存します。コマンド・プロシージャの最後で，もとの保護に戻されます。シンボル置換を要求するためには， SAVE_PROT というシンボルを引用符で囲まなければなりません。