ObjectScript 特殊変数

特殊変数とは、システムによって管理されている変数です。特殊変数はシステム変数とも呼ばれますが、構造化システム変数との混乱を避けるため、ここでは特殊変数と呼びます。

特殊変数名の先頭には、$ が付いています。特殊変数には後に括弧が付かず、パラメータも持たないので、関数と区別されます。特殊変数名は、大文字と小文字が区別されません。多くの特殊変数名には省略形があります。各特殊変数の説明では、最初に完全名を使用した構文が示され、その下に略名を使用した構文が示されます (略名がある場合)。

元来から、特殊変数はスカラ値を保持してきました。システムは自動的に特殊変数を更新し、オペレーティング環境のさまざまな機能を反映します。例えば、$IO 特殊変数は現在のデバイスの ID を含みます。$JOB 特殊変数は、現在のジョブ ID を含みます。

複数の特殊変数を設定できますが、大半は読み取り専用です。この読み取り専用の制約を除き、その他の変数と同様に特殊変数を処理できます。例えば、式で特殊変数を参照したり、別の (ユーザ定義の) 変数に現在の値を代入できます。

実装固有の特殊変数の形式は、それをサポートしているプラットフォームの略語と共に示されています (Windows や UNIX®)。プラットフォーム略語が付いていないものは、すべてのプラットフォームでサポートされています。

特殊変数はアルファベット順で示されます。

$DEVICE – ユーザ定義のデバイス状況情報を含みます。
$ECODE – 現在のエラー・コード文字列を含みます。
$ESTACK – ユーザ定義のポイントから、コール・スタック上に保存されている、コンテキスト・フレーム数を含みます。
$ETRAP – エラー発生時に実行される、ObjectScript コマンドの文字列を含みます。
$HALT – 停止トラップ・ルーチン呼び出しを含みます。
$HOROLOG – 現在のプロセスのローカルな日付と時刻を含みます。
$IO – 現在の入出力デバイスの ID を含みます。
$JOB – 現在のプロセスの ID を含みます。
$KEY – 最新の READ からのターミネータ文字を含みます。
$NAMESPACE – 現在のスタック・レベルのネームスペースを含みます。
$PRINCIPAL – 主入出力デバイスの ID を含みます。
$QUIT – 現在のコンテキストを終了するのに必要な QUIT の種類を示すフラグを含みます。
$ROLES – 現在のプロセスに割り当てられているロールを含みます。
$STACK – コール・スタックに保存されているコンテキスト・フレーム数を含みます。
$STORAGE – ローカル変数ストレージに使用できるバイト数を含みます。
$SYSTEM – システム・オブジェクトに関するシステム情報を含みます。
$TEST – タイムアウト・オプションを使用した最後のコマンドの結果である真理値を含みます。
$THIS – 現在のクラス・コンテキストを含みます。
$THROWOBJ – 失敗した THROW からの OREF が含まれます。
$TLEVEL – トランザクション処理に対する、現在の入れ子レベルを含みます。
$USERNAME – 現在のプロセスのユーザ名を含みます。
$X – カーソルの現在の水平位置を含みます。
$Y – カーソルの現在の垂直位置を含みます。
$ZA – 現在のデバイス上の最後の READ の状況が含まれます。
$ZB – 現在の入出力デバイスに関する状況情報を含みます。
$ZCHILD – 最後の子プロセスの ID を含みます。
$ZEOF – ファイルの最後に到達したかどうかを示すフラグを含みます。
$ZEOS – 圧縮ストリーム読み取り時のストリーム終端ステータスが格納されます。
$ZERROR – 最後のエラーの名前と位置を含みます。
$ZHOROLOG – Caché の開始以後に経過した秒数を含みます。
$ZIO – 現在のターミナル入出力デバイスに関する情報を含みます。
$ZJOB – ジョブの状況情報を含みます。
$ZMODE – 現在の入出力デバイス OPEN パラメータを含みます。
$ZNAME – 現在のルーチン名を含みます。
$ZNSPACE – 現在のネームスペース名を含みます。
$ZORDER – 次のグローバル・ノードの値を含みます。
$ZPARENT – 現在のプロセスの親プロセスの ID を含みます。
$ZPI – 円周率の値を含みます。
$ZPOS – シーケンシャル・ファイルの読み取り中の、現在のファイル位置を含みます。
$ZREFERENCE – 現在のグローバル参照を含みます。
$ZSTORAGE – プロセスに使用可能な最大メモリです。
$ZTIMESTAMP – UTC (Coordinated Universal Time) 形式で、現在の日付と時刻を含みます。
$ZTIMEZONE – グリニッジ子午線からのタイム・ゾーン・オフセットを含みます。
$ZTRAP – 現在のエラー・トラップ・ハンドラの場所が含まれます。
$ZVERSION – Caché の現在のバージョンを表す文字列を含みます。