OpenVMS マニュアル

レキシカル関数

文字列および現在のプロセスに関する属性の情報を戻す関数です。

説明

コマンド言語は，レキシカル関数と呼ばれる機能を含んでいます。レキシカル関数は，現在のプロセスや算術式および文字列に関する情報を返します。コマンド・インタプリタがコマンド処理の入力文字列の解析処理 (レキシカル処理) フェーズを実行する間に関数を評価するため，これらの関数はレキシカル関数と呼ばれます。

通常，シンボルまたは式を使用するコンテキストであれば，任意コンテキストでレキシカル関数を使用できます。コマンド・プロシージャでは，レキシカル関数を使用して論理名の変換，文字列操作の実行，およびプロシージャを処理しているノードの判別を行うことができます。

次に標準的な形式を示します。

F$function-name([args,...])

F$	レキシカル関数が後に続くことを示します。
function-name	関数を評価することを指定するキーワード。一意に認識できれば，関数名は省略できます。
()	必要であれば，引数を囲みます。引数をとらない関数を含め，すべての関数で括弧は必要です。
args,...	必要であれば，整数または文字列式を使用して引数を指定します。

式の指定についての詳細は，『OpenVMS ユーザーズ・マニュアル』を参照してください。

表 1-3 では，レキシカル関数とそれぞれが戻す情報について簡単に説明しています。これ以降のページで，各関数ごとに例を挙げて詳しく説明します。

表 1-3 レキシカル関数の要約

関数	説明
F$CONTEXT	F$PID 関数とともに使用し，その選択基準を指定します。
F$CSID	OpenVMS Cluster識別番号を戻します。また，コンテキスト・シンボルが，システムのノード・リストの中で，現在の位置を示すように変更します。
F$CUNITS	数値を，指定された単位から他の単位へ変換します。
F$CVSI	文字列データからビット・フィールドを取り出し，その結果を符号付き値として整数に変換します。
F$CVTIME	絶対時刻，デルタ時間またはそれらの組み合せの文字列に関する情報を戻します。
F$CVUI	文字データからビット・フィールドを取り出し，その結果を符号なし値として整数に変換します。
F$DELTA_TIME	指定した開始時刻と終了時刻の差を返します。
F$DEVICE	選択基準に合う装置名をすべて返します。
F$DIRECTORY	現在の省略時のディレクトリ名文字列を戻します。
F$EDIT	編集リストに指定された編集をもとに，文字列式を編集します。
F$ELEMENT	指定した区切り文字で区切られた要素で構成される文字列から， 1 つの要素を取り出します。
F$ENVIRONMENT	DCL コマンド環境に関する情報を戻します。
F$EXTRACT	文字列式から部分文字列を取り出します。
F$FAO	$FAO システム・サービスを呼び出し，指定された制御文字列を ASCII 形式の出力文字列に変換します。
F$FID_TO_NAME (Alpha/Integrity のみ)	ファイル識別をファイル指定に変換します。
F$FILE_ATTRIBUTES	指定されたファイルの属性に関する情報を戻します。
F$GETDVI	$GETDVI システム・サービスを呼び出し，指定された装置に関する指定された情報を戻します。
F$GETENV (Alpha のみ)	$GETENV システム・サービスを呼び出し，指定されたコンソール環境変数の値を戻します。
F$GETJPI	$GETJPI システム・サービスを呼び出し，指定されたプロセスに関する会計情報，状態情報，および識別情報を戻します。
F$GETQUI	$GETQUI システム・サービスを呼び出し，キューに関する情報を戻します。この情報には，バッチ・キュー，プリント・キューに登録されるジョブ，ファーム定義やシステム・バッチ・キュー・ファイルに定義された属性などが含まれます。
F$GETSYI	$GETSYI システム・サービスを呼び出し，利用者のシステムに関する状態情報と識別情報を戻します (システムが，VMScluster の一部に含まれている場合には，ローカルなノードに関する状態情報と識別情報を戻します)。
F$IDENTIFIER	指定した形式の識別子を，それに相当する整数に変換します。あるいは，その逆の操作を実行します。
F$INTEGER	指定した式の結果を，整数で戻します。
F$LENGTH	指定した文字列の長さを戻します。
F$LICENSE (Alpha/Integrity のみ)	指定されたライセンスがシステムにロードされているかどうかを確認します。
F$LOCATE	文字列に含まれる 1 文字または部分文字列を探し，文字列中でのそのオフセットを戻します。
F$MATCH_WILD	候補とパターン文字列の間でワイルドカード照合を行います。
F$MESSAGE	指定したシステム状態コードに対応するメッセージ文を戻します。
F$MODE	プロセスが実行されているモードを示す文字列を戻します。
F$MULTIPATH (Alpha/Integrity のみ)	特定のマルチパス対応装置に対する，指定された情報項目を戻します。
F$PARSE	$PARSE RMS サービスを起動してファイル指定を解析し，指定した特定のファイル指定，または拡張されたファイル指定を戻します。
F$PID	起動するたびに，次のプロセス識別番号を戻します。
F$PRIVILEGE	現在のプロセス特権が，引数に指定されている特権と一致するかどうかに応じて， TRUE または FALSE という値を戻します。
F$PROCESS	現在のプロセス名を文字列で戻します。
F$SEARCH	$SEARCH RMS サービスを呼び出し，ディレクトリ・ファイルを検索し，指定したファイルの完全な形のファイル指定を戻します。
F$SETPRV	指定された特権をセットし，変更される前の特権の状態を示しているキーワード・リストを戻します。
F$STRING	指定した式の結果に相当する文字列を戻します。
F$TIME	現在の日付/時刻を示す文字列を戻します。形式は dd-mmm-yyyy hh:mm:ss.cc です。
F$TRNLNM	論理名を変換し，等価名文字列，または要求されている論理名の属性を戻します。
F$TYPE	シンボルのデータ・タイプを判断します。
F$UNIQUE (Alpha/Integrity のみ)	ファイル名として適切で，クラスタ全体で一意な文字列を生成します。
F$USER	現在の利用者識別コード（UIC）を戻します。
F$VERIFY	プロシージャ・チェックの設定がオンの場合には整数の 1，プロシージャ・チェックの設定がオフの場合には整数の 0 が戻されます。また，新しいチェック状態をセットすることもできます。