Compaq OpenVMS
DCL ディクショナリ


前へ 次へ 目次 索引


F$GETQUI

$GETQUI システム・サービスを呼び出し,キューに関する情報を戻します。これらの情報にはバッチ・キューおよびプリント・キューに登録されるジョブ,フォーム定義,およびキュー・データベースに保存されている属性定義が含まれます。

キュー・マネージャについての情報も戻します。

ほとんどの操作では,読み込み(R)アクセス権が必要です。


形式

F$GETQUI (機能,[項目],[オブジェクト id],[フラグ])

戻り値


指定する項目に応じて,整数または文字列になります。論理値を戻す項目については,文字列 TRUE または FALSE が戻されます。 $GETQUI システム・サービスがエラー・コードを返した場合, F$GETQUI は空文字列を返します。

引数

機能

F$GETQUI レキシカル関数が実行する動作を指定します。 F$GETQUI は, $GETQUI システム・サービスで指定できるすべての機能をサポートしています。これらの機能を次の表に示します。

関数 説明
CANCEL_OPERATION 前の F$GETQUI 呼び出しにより開始したワイルドカード操作を終了させる。
DISPLAY_CHARACTERISTIC 特定の属性定義,またはワイルドカード操作での次の属性定義に関する情報を返す。
DISPLAY_ENTRY ワイルドカード操作で選択基準に一致する,特定のジョブ・エントリまたは次のジョブ・エントリに関する情報を返す。返されるジョブ情報の点において, DISPLAY_ENTRY の関数コードはDISPLAY_JOB 関数コードに似ている。ただし DISPLAY_JOB は,キュー・コンテキストを確立しなければならない。 DISPLAY_ENTRY は,キュー・コンテキストを確立する必要はない。現在のプロセスのユーザ名と一致するこれらのエントリだけが実行されます。
DISPLAY_FILE 現在のジョブ・コンテキストのために定義した次のファイルに関する情報を返す。 F$GETQUI 呼び出しを行いファイル情報を要求する前に, (DISPLAY_QUEUE および DISPLAY_JOB 関数コードを使用して) キューおよびジョブ情報を表示するために,または(DISPLAY_ENTRY 関数コードを使用して) エントリ情報を表示するために呼び出しを行う必要がある。
DISPLAY_FORM 特定のフォーム定義,またはワイルドカード操作で次のフォーム定義を返す。
DISPLAY_JOB 現在のキュー・コンテキストに対して定義された次のジョブに関する情報を返す。 F$GETQUI 呼び出しを行いジョブ情報を要求する前に, (DISPLAY_QUEUE 関数コードを使用して) キュー情報を表示するために呼び出しを行う必要がある。返されるジョブ情報の点において, DISPLAY_JOB 関数コードと DISPLAY_ENTRY 関数コードは似ている。ただし DISPLAY_JOB は,キュー・コンテキストを確立しなければならない。 DISPLAY_ENTRY は,キュー・コンテキストを確立する必要はない。
DISPLAY_MANAGER 特定のキュー・マネージャ,またはワイルドカード操作で次のキュー・マネージャに関する情報を返す。
DISPLAY_QUEUE 特定のキュー定義,またはワイルドカード操作で次のキュー定義に関する情報を返す。
TRANSLATE_QUEUE キューの論理名を変換する。

項目コード, オブジェクト id, または フラグ 引数に指定できない関数の引数もあります。各関数の引数とそれに対応するフォーマット行を,次の表に示します。また,項目コードオブジェクト・コード,および フラグ 引数は,必須であるか,オプションであるか,あるいは適用外であるかも示します。次の表において,([]) は,オプションの引数を示します。引数がないことは,引数を指定できないことを示します。 2 つのコンマ (,,) は, (オプション/適用外のいずれの場合でも) 省略された引数を示すプレースホルダとして使用します。

関数 フォーマット行
CANCEL_OPERATION F$GETQUI("CANCEL_OPERATION") またはF$GETQUI(" ")
DISPLAY_CHARACTERISTIC F$GETQUI("DISPLAY_CHARACTERISTIC",[item],object-id,[flags])
DISPLAY_ENTRY F$GETQUI("DISPLAY_ENTRY",[item],[object-id],[flags])
DISPLAY_FILE F$GETQUI("DISPLAY_FILE",[item],,[flags])
DISPLAY_FORM F$GETQUI("DISPLAY_FORM",[item],object-id,[flags])
DISPLAY_JOB F$GETQUI("DISPLAY_JOB",[item],,[flags])
DISPLAY_MANAGER F$GETQUI("DISPLAY_MANAGER",[item],object-id,[flags])
DISPLAY_QUEUE F$GETQUI("DISPLAY_QUEUE",[item],object-id,[flags])
TRANSLATE_QUEUE F$GETQUI("TRANSLATE_QUEUE",[item],object-id)

項目

$GETQUI システム・サービスの出力項目コードに相当します。特定のキュー,ジョブ,ファイル,フォーム,または属性に関する情報の種類を指定します。 VAX では, キュー・マネージャ情報も指定できます。 表 DCLI-9 では戻される項目コードとデータ・タイプを示しています。

オブジェクト id

$GETQUI システム・サービスの QUI$SEARCH_NAME, QUI$_SEARCH_NUMBER,および QUI$_SEARCH_JOB_NAME入力項目コードに相当します。 F$GETQUI が情報を返すオブジェクト (たとえば特定のキュー名,ジョブ名,またはフォーム番号など) のオブジェクト名または番号を指定します。次に示す関数では,ワイルドカードを使用できます。
DISPLAY_CHARACTERISTIC
DISPLAY_ENTRY
DISPLAY_FORM
DISPLAY_MANAGER
DISPLAY_QUEUE

後続の呼び出しで,オブジェクト id 引数としてワイルドカードを指定すると,特定のキューに登録されてる 1 つまたは複数ジョブ,または特定のキューに登録されているジョブのファイルの状態情報を得ることができます。名前にワイルドカード文字を使用した場合は,各呼び出しはリストで次のオブジェクト(キュー,フォームなど)の情報を返します。リストの最後に達した場合は,空文字列("") を返します。ワイルドカードが使用できるのはオブジェクト名だけで,オブジェクト番号には使用できません。

フラグ

$GETQUI システム・サービスの QUI$_SEARCH_FLAGS 入力項目コードに相当するキーワードのリストを,コンマで区切って指定します。これらのフラグは, $GETQUI システム・サービス呼び出しで指定した,オブジェクト検索の範囲を定義します。検索フラグとして使用可能なキーワードを 表 DCLI-8 に示します。

表 DCLI-8 F$GETQUI キーワード
キーワード 有効な関数コード 説明
ALL_JOBS DISPLAY_JOB 設定されたキュー・コンテキスト内の全てのジョブを検索するよう F$GETQUI に要求する。このフラグを設定しないと, F$GETQUI は呼び出したユーザと同じユーザ名を持つジョブの情報のみ返す。
BATCH DISPLAY_QUEUE
DISPLAY_ENTRY
バッチ・キューを選択する。
EXECUTING_JOBS DISPLAY_ENTRY
DISPLAY_JOB
実行中ジョブを選択する。
FREEZE_CONTEXT DISPLAY_CHARACTERISTIC
DISPLAY_ENTRY
DISPLAY_FILE
DISPLAY_FORM
DISPLAY_JOB
DISPLAY_MANAGER
DISPLAY_QUEUE
ワイルド・カード操作時,操作対象が次に進めない。このフラグを設定しないと,コンテキストは次のオブジェクトに進む。
GENERIC DISPLAY_ENTRY
DISPLAY_QUEUE
総称キューを選択する。
HOLDING_JOBS DISPLAY_ENTRY
DISPLAY_JOB
保留ジョブを選択する。
PENDING_JOBS DISPLAY_ENTRY
DISPLAY_JOB
待ち状態のジョブを選択する。
PRINTER DISPLAY_QUEUE
DISPLAY_ENTRY
プリンタ・キューを選択する。
RETAINED_JOBS DISPLAY_ENTRY
DISPLAY_JOB
保持されたジョブを選択する。
SERVER DISPLAY_QUEUE
DISPLAY_ENTRY
サーバ・キューを選択する。
SYMBIONT DISPLAY_QUEUE
DISPLAY_ENTRY
すべての出力を選択する。
"PRINTER,SERVER,TERMINAL" と等価。
TERMINAL DISPLAY_QUEUE
DISPLAY_ENTRY
ターミナル・キューを選択する。
THIS_JOB DISPLAY_FILE
DISPLAY_JOB
DISPLAY_QUEUE
バッチ・ジョブ呼び出し,実行されるコマンド・ファイル,またはバッチ・キュー呼び出しに関連するキューに関する,すべてのジョブ・ファイル情報を選択する。
TIMED_RELEASE_JOBS DISPLAY_ENTRY
DISPLAY_JOB
開始時刻の指定されたジョブを選択する。
WILDCARD DISPLAY_CHARACTERISTIC
DISPLAY_ENTRY
DISPLAY_FORM
DISPLAY_MANAGER
DISPLAY_QUEUE
コンテキストを設定し保存する。コンテキストが保存されるため,次の操作はそのコンテキストに基づいて実行される。


説明

F$GETQUI レキシカル関数は,$GETQUI システム・サービスを呼び出し,キューに関する情報を戻します。戻される情報には,バッチ・キューやプリント・キューに登録されているジョブ,フォーム定義,およびシステム・ジョブ・キュー・ファイルに定義された属性が含まれます。F$GETQUI レキシカル関数は,ワイルドカードの操作やネストしたワイルドカード操作を含め, $GETQUI システム・サービスのすべての機能を提供します。たとえば,ネストしたワイルドカードの操作では,他のオブジェクト内で定義された情報を戻します。呼び出しを繰り返した後,選択したキューに含まれるジョブ,または選択したジョブに含まれるファイルを照会する場合,この機能は特に便利です。各々の呼び出しの後,システムは,後続の呼び出しに必要なキューまたはコンテキストを提供できるように, GQC (内部 GETQUI コンテキスト・ブロック) を保存します。詳細は,『OpenVMS System Services Reference Manual』の $GETQUI システム・サービスの説明を参照してください。

F$GETQUI レキシカル関数は, $GETQUI システム・サービスで指定されたすべての項目の情報を戻します。 $GETQUI レキシカル関数に指定する項目, 戻される情報, およびその情報のデータ・タイプを 表 DCLI-9 に示します。

表 DCLI-9 F$GETQUI 項目
項目 データ・タイプ 戻される情報
ACCOUNT_NAME 1 文字列 指定したジョブの所有者のアカウント名。
AFTER_TIME 文字列 指定したジョブを実行するシステム時刻。
ASSIGNED_QUEUE_NAME 1 文字列 F$GETQUI 呼び出しで指定した論理キューが割り当てられる実行キュー名。
AUTOSTART_ON 文字列 キューが始まる位置を示すノード,またはノード装置の組合せリスト。
BASE_PRIORITY 整数値 バッチ実行キューでのジョブの優先順位,または出力キューを制御するシンビオント・プロセスの優先順位。
CHARACTERISTICS 1 文字列 指定したキューまたはジョブに関する属性。
CHARACTERISTIC_NAME 文字列 指定した属性名。
CHARACTERISTIC_NUMBER 整数値 指定した属性番号。
CHECKPOINT_DATA 1 文字列 指定したバッチ・ジョブが再スタートする時の,シンボル BATCH$RESTART の値。
CLI 1 文字列 指定したバッチ・ジョブを実行するコマンド言語インタプリタ(CLI)名。ファイル指定では装置名を SYS$SYSTEM , ファイル・タイプを EXE とみなす。
COMPLETED_BLOCKS 整数値 指定したプリント・ジョブに対して処理したシンビオントのブロック数。プリント・ジョブにのみ適用される。
CONDITION_VECTOR 1 整数値 3 つのロングワードのベクトル。最初のロングワードは指定したジョブの終了状態を示す。第 2,第 3 のロングワードはプリント・ジョブの付加状態を示す。
CPU_DEFAULT 文字列 キューに対して指定した省略時の CPU 時間をデルタ時間で表す。バッチ実行キューにのみ適用される。
CPU_LIMIT 1 文字列 指定したジョブまたはキューに対して指定した最大 CPU 時間の上限をデルタ時間で表す。バッチ・ジョブ,およびバッチ実行キューにのみ適用される。
DEFAULT_FORM_NAME 文字列 指定した出力キューに関連する省略時のフォーム名。
DEFAULT_FORM_STOCK 文字列 省略時のフォームがプリントされるように指定した用紙名。
DEVICE_NAME 文字列 指定した実行キューがあるノードまたは装置(あるいはその両方)。出力実行キューの場合は,装置名のみが戻される。ノード名は,デュアル・アーキテクチャ OpenVMS Cluster システムでのみ使用される。キューを実行するプロセスのシステム・パラメータ SCSNODE により,ノード名が指定される。

バッチ実行キューの場合は,空文字列 ("") が戻される。バッチ・キューが実行しているノード名を得るには, SCSNODE_NAME を使用する。

ENTRY_NUMBER 整数値 指定したジョブのキュー・エントリ番号。
EXECUTING_JOB_COUNT 整数値 現在実行中のキューにあるジョブ数。
FILE_BURST 文字列 ファイルの前にバースト・ページおよびフラグ・ページがプリントされている場合は TRUE, そうでない場合は FALSE を戻す。
FILE_CHECKPOINTED 1 文字列 指定したファイルにチェックポイントが設定されている場合は TRUE, そうでない場合は FALSE を戻す。
FILE_COPIES 1 整数値 指定したファイルが処理される時間。出力実行キューにのみ適用される。
FILE_COPIES_DONE 1 整数値 指定したファイルが処理されていた時間。出力実行キューにのみ適用される。
FILE_COUNT 整数値 指定したジョブ中のファイル数。
FILE_DELETE 文字列 要求が実行された後にファイルが削除される場合は TRUE, そうでない場合は FALSE を戻す。
FILE_DOUBLE_SPACE 文字列 シンビオントがダブル・スペーシングでファイルをフォーマットしている場合はTRUE,そうでない場合は FALSE を戻す。
FILE_EXECUTING 1 文字列 指定したファイルが処理中である場合はTRUE, そうでない場合は FALSE を戻す。
FILE_FLAG 文字列 ファイルの前にフラグ・ページがプリントされる場合はTRUE, そうでない場合は FALSE を戻す。
FILE_FLAGS 1 整数値 指定したファイル用に選択された処理オプション。整数値はビット・フィールドを表す。フィールドの各ビット設定を確認するためには, FILE_FLAGS のかわりに次の項目のいずれか 1 つを使用する。
FILE_BURST
FILE_DELETE
FILE_DOUBLE_SPACE
FILE_FLAG
FILE_PAGE_HEADER
FILE_PAGINATE
FILE_PASSALL
FILE_TRAILER
FILE_IDENTIFICATION 1 文字列 選択したファイルを一意に識別する内部ファイル識別値。以下の RMS NAM ブロックの 3 ファイル識別フィールドを順に指定する。
NAM$T_DVI (16 バイト)
NAM$W_FID (6 バイト)
NAM$W_DID (6 バイト)
FILE_PAGE_HEADER 文字列 各出力ページにヘッダがプリントされる場合はTRUE, そうでない場合は FALSE を戻す。
FILE_PAGINATE 文字列 下マージンで改ページを挿入して編集する場合は TRUE, そうでない場合は FALSEを戻す。
FILE_PASSALL 文字列 PASSALL モードでプリントする場合は TRUE, そうでない場合は FALSE を戻す。
FILE_SETUP_MODULES 1 文字列 装置制御ライブラリから抽出され,指定したファイルがプリントされる前にコピーするテキスト・モジュール名。出力実行キューでのみ適用される。
FILE_SPECIFICATION 1 文字列 F$GETQUI が情報を戻すファイルの,完全修飾 RMS ファイル指定。
FILE_STATUS 1 整数値 ファイル状態情報。整数値はビット・フィールドを表す。フィールドの各ビット設定を検索するためには, FILE_STATUS のかわりに次の項目のいずれか 1 つを使用する。
FILE_CHECKPOINTED
FILE_EXECUTING
FILE_TRAILER 文字列 ファイルに続いてトレーラ・ページがプリントされる場合は TRUE, そうでない場合は FALSE を戻す。
FIRST_PAGE 1 整数値 指定したファイルのプリントを始めるページ番号。出力実行キューでのみ適用される。
FORM_DESCRIPTION 文字列 ユーザおよびオペレータに,指定したフォームを示すテキスト文字列。
FORM_FLAGS 整数値 指定フォームのために選択された処理オプション。フィールドの各ビット設定を確認するためには, FORM_FLAGS のかわりに次の項目のいずれか 1 つを使用する。
FORM_SHEET_FEED
FORM_TRUNCATE
FORM_WRAP
FORM_LENGTH 整数値 指定したフォームの物理的な長さを行数で表す。出力実行キューでのみ適用される。
FORM_MARGIN_BOTTOM 整数値 指定したフォームの下マージンを行数で表す。
FORM_MARGIN_LEFT 整数値 指定したフォームの左マージンを文字数で表す。
FORM_MARGIN_RIGHT 整数値 指定したフォームの右マージンを文字数で表す。
FORM_MARGIN_TOP 整数値 指定したフォームの上マージンを行数で表す。
FORM_NAME 1 文字列 指定したジョブまたはキューに関連する,指定したフォーム名,あるいはマウントされたフォーム名。
FORM_NUMBER 整数値 指定したフォーム数。
FORM_SETUP_MODULES 文字列 装置制御ライブラリから抽出され,指定したフォームでファイルがプリントされる前にコピーするテキスト・モジュール名。出力実行キューでのみ適用される。
FORM_SHEET_FEED 文字列 他の用紙を挿入できるように,物理ページの終わりにシンビオント一時停止をする場合は TRUE, そうでない場合は FALSE を戻す。
FORM_STOCK 1 文字列 指定したフォームがプリントされる用紙名。
FORM_TRUNCATE 文字列 プリンタが右マージンを越えている文字を捨てる場合は TRUE, そうでない場合はFALSE を戻す。
FORM_WIDTH 整数値 指定したフォームの幅。
FORM_WRAP 文字列 後続の行で右マージンを越えている文字をプリントする場合は TRUE, そうでない場合は FALSE を戻す。
GENERIC_TARGET 文字列 指定した汎用キューからの作業を受け入れられる実行キュー名。汎用キューにのみ適用される。
HOLDING_JOB_COUNT 整数値 明示的にリリースまで保留になっているキューに登録されているジョブ数。
INTERVENING_BLOCKS 整数値 現在の F$GETQUI 呼び出しの間にスキップされた,待ち状態のジョブに関連するブロック数。これらは,F$GETQUI 呼び出しの選択基準と一致しないため報告されない。
INTERVENING_JOBS 整数値 F$GETQUI 呼び出しの間にスキップされた,待ち状態のジョブ数。これらは,F$GETQUI 呼び出しの選択基準と一致しないため報告されない。
JOB_ABORTING 文字列 ジョブを強制終了させる場合は TRUE, そうでない場合は FALSE を戻す。
JOB_COMPLETION_QUEUE 1 文字列 指定したジョブが実行されたキュー名。
JOB_COMPLETION_TIME 1 文字列 指定したジョブが完了した時刻。
JOB_COPIES 1 整数値 指定したプリント・ジョブが繰り返される回数。
JOB_COPIES_DONE 1 整数値 指定したプリント・ジョブが繰り返された回数。
JOB_CPU_LIMIT 1 文字列 ジョブに対して CPU 時間上限が指定されている場合は TRUE, そうでない場合は FALSE を戻す。
JOB_ERROR_RETENTION 1 文字列 ジョブが失敗して終了した場合に,そのままキューに残しておくようにユーザが要求した場合は TRUE, そうでない場合は FALSE を戻す。
JOB_EXECUTING 文字列 指定したジョブが実行中あるいはプリント中である場合はTRUE, そうでない場合は FALSE を戻す。
JOB_FILE_BURST 1 文字列 ジョブに対してバースト・ページのオプションが明示的に指定されている場合は TRUE, そうでない場合は FALSE を戻す。
JOB_FILE_BURST_ONE 1 文字列 ジョブの最初のファイルの前でのみ,バースト・ページおよびフラグ・ページを入れる場合は TRUE, そうでない場合は FALSE を戻す。
JOB_FILE_FLAG 1 文字列 ジョブに登録されているそれぞれのファイルの前にフラグ・ページを入れる場合は TRUE, そうでない場合は FALSE を戻す。
JOB_FILE_FLAG_ONE 1 文字列 ジョブの最初のファイルの前でのみ,フラグ・ページを入れる場合は TRUE, そうでない場合は FALSE を戻す。
JOB_FILE_PAGINATE 1 文字列 ジョブに対して明示的にページング・オプションを指定している場合は TRUE, そうでない場合は FALSEを戻す。
JOB_FILE_TRAILER 1 文字列 ジョブの各ファイルの後にトレーラ・ページが続く場合は TRUE, そうでない場合はFALSE を戻す。
JOB_FILE_TRAILER_ONE 1 文字列 ジョブの最後のファイルのコピーのみにトレーラ・ページが続く場合は TRUE, そうでない場合は FALSE を戻す。
JOB_FLAGS 1 整数値 指定したジョブに対して選択した処理オプション。整数値はビット・フィールドを表す。フィールドの各ビット設定を確認検索するためには, JOB_FLAGS のかわりに次の項目のいずれか 1 つを使用します。
JOB_CPU_LIMIT
JOB_ERROR_RETENTION
JOB_FILE_BURST
JOB_FILE_BURST_ONE
JOB_FILE_FLAG
JOB_FILE_FLAG_ONE
JOB_FILE_PAGINATE
JOB_FILE_TRAILER
JOB_FILE_TRAILER_ONE
JOB_LOG_DELETE
JOB_LOG_NULL
JOB_LOG_SPOOL
JOB_LOWERCASE
JOB_NOTIFY
JOB_RESTART
JOB_RETENTION_TIME
JOB_WSDEFAULT
JOB_WSEXTENT
JOB_WSQUOTA
JOB_HOLDING 文字列 明示的にリリースされるまでジョブが保留される場合は TRUE, そうでない場合は FALSE を戻す。
JOB_INACCESSIBLE 文字列 特定のジョブ,およびシステム・キュー・ファイルのファイル情報への読み込みアクセス権がない場合は TRUE,そうでない場合は FALSE を戻す。 FALSE の場合, DISPLAY_JOB および DISPLAY_FILE 操作は,次の出力値項目コードの情報のみ戻す。
AFTER_TIME
COMPLETED_BLOCKS
ENTRY_NUMBER
INTERVENING_BLOCKS
INTERVENING_JOBS
JOB_SIZE
JOB_STATUS
JOB_LIMIT 整数値 指定したキューで同時に実行できるジョブ数。バッチ実行キューにのみ適用される。
JOB_LOG_DELETE 1 文字列 プリントした後にログ・ファイルを削除する場合は TRUE, そうでない場合は FALSEを戻す。
JOB_LOG_NULL 1 文字列 ログ・ファイルが作成されない場合は TRUE, そうでない場合は FALSE を戻す。
JOB_LOG_SPOOL 1 文字列 ジョブの終了時に,ログ・ファイルがプリント・キューに登録される場合は TRUE, そうでない場合は FALSE を戻す。
JOB_LOWERCASE 1 文字列 大文字と小文字の両方が印刷できるプリンタでプリントされる場合は TRUE, そうでない場合は FALSE を戻す。
JOB_NAME 1 文字列 指定したジョブ名。
JOB_NOTIFY 1 文字列 ジョブが完了または強制終了した時に,ターミナルにメッセージを送信する場合はTRUE, そうでない場合は FALSE を戻す。
JOB_PENDING 文字列 ジョブが待ち状態である場合は TRUE, そうでない場合は FALSE を戻す。
JOB_PID 文字列 バッチ・ジョブを実行するプロセス識別番号(PID)。
JOB_REFUSED 文字列 ジョブがシンビオントによって拒否され処理を待っている状態である場合は TRUE, そうでない場合は FALSE を戻す。
JOB_RESET_MODULES 文字列 装置制御ライブラリから抽出され,指定したキューに登録された各ジョブがプリントされる前に,プリンタにコピーされたテキスト・モジュール名。出力実行キューでのみ適用される。
JOB_RESTART 1 文字列 ジョブがシステム障害の後に再スタートする,または実行中に再度キューに登録できる場合は TRUE, そうでない場合は FALSE を戻す。
JOB_RETAINED 文字列 終了してもまだキューにジョブが残っている場合は TRUE, そうでない場合は FALSE を戻す。
JOB_RETENTION 文字列 ジョブの終了状態にかかわらず,キューにジョブが残るようにユーザが要求した場合はTRUE, そうでない場合は FALSE を戻す。
JOB_RETENTION_TIME 1 文字列 キューにジョブを残すようにユーザが要求するまでのシステム時間。絶対時間またはデルタ時間で表す。
JOB_SIZE 整数値 指定したプリント・ジョブのブロック総数。
JOB_SIZE_MAXIMUM 整数値 指定したキューに登録できるプリント・ジョブの最大ブロック数。出力実行キューにのみ適用される。
JOB_SIZE_MINIMUM 整数値 指定したキューに登録できるプリント・ジョブの最小ブロック数。出力実行キューにのみ適用される。
JOB_STALLED 文字列 ジョブをプリントしている物理装置が一時停止しているためにジョブが一時停止している場合は TRUE,そうでない場合は FALSE を戻す。
JOB_STARTING 文字列 ジョブ・コントローラが処理を開始し,出力シンビオントまたは他のノードのジョブ・コントローラと通信を開始していた場合は TRUE, そうでない場合は FALSE を戻す。
JOB_STATUS 整数値 指定したジョブの状態フラグ。整数値はビット・フィールドを表す。フィールドの各ビット設定を確認するためには, JOB_STATUS のかわりに次の項目のいずれか 1 つを使用する。
JOB_ABORTING
JOB_EXECUTING
JOB_HOLDING
JOB_INACCESSIBLE
JOB_REFUSED
JOB_REQUEUE
JOB_RESTART
JOB_RETAINED
JOB_STARTING
JOB_TIMED_RELEASE
JOB_SUSPENDED
JOB_PENDING
JOB_SUSPENDED 文字列 ジョブが中断されている場合は TRUE, そうでない場合は FALSE を戻す。
JOB_TIMED_RELEASE 文字列 指定した時刻までジョブが実行を待っている場合は TRUE, そうでない場合は FALSE を戻す。
JOB_WSDEFAULT 1 文字列 ジョブに対して省略時のワーキング・セット・サイズが指定されている場合は TRUE, そうでない場合は FALSE を戻す。
JOB_WSEXTENT 1 文字列 ジョブに対してワーキング・セット拡張が指定されている場合は TRUE, そうでない場合はFALSE を戻す。
JOB_WSQUOTA 1 文字列 ジョブに対してワーキング・セット制限が指定されている場合は TRUE, そうでない場合は FALSE を戻す。
LAST_PAGE 1 整数値 指定したファイルのプリントが終了するページ番号。出力実行キューにのみ適用される。
LIBRARY_SPECIFICATION 文字列 指定したキューの装置制御ライブラリ名。装置とディレクトリ名は SYS$LIBRARY, ファイル・タイプは .TLB とみなす。出力実行キューにのみ適用される。
LOG_QUEUE 1 文字列 指定したバッチ・ジョブをプリントするために,ログ・ファイルが作成されるキュー名。出力実行キューにのみ適用される。
LOG_SPECIFICATION 1 文字列 ジョブに対して指定したログ・ファイル名。バッチ・ジョブにのみ適用される。 JOB_LOG_NULL コードを使用して,ログ・ファイルを作成するか決定する。
MANAGER_NAME 文字列 キュー・マネージャ名。
MANAGER_NODES 文字列 キュー・マネージャを実行するノード名。
MANAGER_STATUS 整数値 指定したキュー・マネージャの状態フラグ。フィールドの各ビット設定を確認するためには, MANAGER_STATUS のかわりに次の項目のいずれか 1 つを使用する。
MANAGER_FAILOVER
MANAGER_RUNNING
MANAGER_START_PENDING
MANAGER_STARTING
MANAGER_STOPPED
MANAGER_STOPPING
NOTE 1 文字列 指定したジョブの,ジョブ・フラグ・ページおよびファイル・フラグ・ページにプリントされる注意書き。出力実行キューにのみ適用される。
OPERATOR_REQUEST 1 文字列 指定したジョブを実行する前にキュー・オペレータに送るメッセージ。出力実行キューにのみ適用される。
OWNER_UIC 1 文字列 指定したキュー所有者の利用者識別コード。
PAGE_SETUP_MODULES 文字列 装置制御ライブラリから抽出され,フォームの各ページがプリントされる前にプリンタにコピーされたテキスト・モジュール名。
PARAMETER_1 to PARAMETER_8 1 文字列 シンボル P1 〜 P8 それぞれの値となる,利用者定義パラメータの値。
PENDING_JOB_BLOCK_COUNT 整数値 キューで待ち状態になっているすべてのジョブのブロック総数(出力実行キューのみ)。
PENDING_JOB_COUNT 整数値 待ち状態になっているジョブ数。
PENDING_JOB_REASON 整数値 ジョブが待ち状態になっている理由。整数値はビット・フィールドを表す。フィールドの各ビット設定を確認するためには, PENDING_JOB_REASON のかわりに次の項目のいずれか 1 つを使用する。
PEND_CHAR_MISMATCH
PEND_JOB_SIZE_MAX
PEND_JOB_SIZE_MIN
PEND_LOWERCASE_MISMATCH
PEND_NO_ACCESS
PEND_QUEUE_BUSY
PEND_QUEUE_STATE
PEND_STOCK_MISMATCH
PEND_CHAR_MISMATCH 文字列 実行キューで使用できない属性を要求している場合は TRUE, そうでない場合は FALSE を戻す。
PEND_JOB_SIZE_MAX 文字列 ジョブのブロック数が実行キューのブロック上限を越えている場合は TRUE, そうでない場合は FALSE を戻す。
PEND_JOB_SIZE_MIN 文字列 ジョブのブロック数が実行キューのブロック下限よりも少ない場合は TRUE, そうでない場合は FALSE を戻す。
PEND_LOWERCASE_MISMATCH 文字列 ジョブが小文字用のプリンタを必要とする場合は TRUE, そうでない場合は FALSE を戻す。
PEND_NO_ACCESS 文字列 ジョブ所有者が実行キューへのアクセス権がない場合は TRUE, そうでない場合はFALSE を戻す。
PEND_QUEUE_BUSY 文字列 キューのジョブ制限と現在実行中のジョブ数が等しいために,ジョブが待ち状態になっている場合は TRUE, そうでない場合は FALSE を戻す。
PEND_QUEUE_STATE 文字列 実行キューが実行中のオープン状態でないためにジョブが待ち状態になっている場合は TRUE, そうでない場合は FALSE を戻す。
PEND_STOCK_MISMATCH 文字列 ジョブのフォームで必要なストックの形式が,実行キューでマウントされた形式と一致しない場合は TRUE, そうでない場合は FALSE を戻す。
PRIORITY 1 整数値 指定したジョブのスケジューリング優先順位。
PROCESSOR 文字列 指定したキューから実行するプリント・ジョブを実行するシンビオント・イメージ名。
PROTECTION 1 文字列 指定したキューの保護マスク。
QUEUE_ACL_SPECIFIED 文字列 キューに対してアクセス制御リストが指定されている場合は TRUE, そうでない場合は FALSEを戻す。
QUEUE_ALIGNING 文字列 現在アラインメント・ページをプリントしている場合は TRUE, そうでない場合は FALSE を戻す。 START/QUEUE/ALIGN コマンドを使用して再スタートしたときに,アライメント・ページをプリントする。
QUEUE_AUTOSTART 文字列 指定したキューが AUTOSTART キューと指定されている場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_AUTOSTART_INACTIVE 文字列 キューが,自動的に始動しないよう設定した自動起動キューである場合は TRUE, そうでない場合は FALSE を戻す。 TRUE の場合は, START/QUEUE または INIT/QUEUE/START コマンドを実行して再起動させる。
QUEUE_AVAILABLE 文字列 キューで 2 つ以上のジョブを処理していて, さらに追加のジョブを処理できるキューである場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_BATCH 文字列 キューが,バッチ・キューまたは汎用バッチ・キューである場合は TRUE, そうでない場合は FALSEを戻す。
QUEUE_BUSY 文字列 現在実行中のジョブ数が,キューのジョブ制限と等しい場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_CLOSED 文字列 キューがオープン状態になるまでクローズされ,新しいジョブを受け入れない場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_CPU_DEFAULT 文字列 キューに登録されたすべてのジョブに対して省略時の CPU 時間制限が指定されている場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_CPU_LIMIT 文字列 キューに登録されたすべてのジョブに対して省略時の最大 CPU 時間制限が指定されている場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_DESCRIPTION 文字列 INITIALIZE/QUEUE コマンドに /DESCRIPTION 修飾子を指定して定義したキューの説明。
QUEUE_DIRECTORY 文字列 キュー・マネージャのキュー・データベース・ディレクトリの装置およびディレクトリ指定。
QUEUE_FILE_BURST 文字列 キューで実行する各ジョブの各ファイルの前に,バースト・ページおよびフラグ・ページを入れる場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_FILE_BURST_ONE 文字列 キューが実行する各ジョブの最初のファイルの前にのみ,バースト・ページおよびフラグ・ページを入れる場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_FILE_FLAG 文字列 キューが実行する各ジョブの各ファイルの前にフラグ・ページを入れる場合は TRUE,そうでない場合は FALSE を戻す。
QUEUE_FILE_FLAG_ONE 文字列 キューが実行する各ジョブの最初のファイルの前にのみ,フラグ・ページを入れる場合は TRUE,そうでない場合は FALSE を戻す。
QUEUE_FILE_PAGINATE 文字列 このキューが実行する各ジョブの出力シンビオントが出力をページングする場合は TRUE, そうでない場合は FALSE を戻す。出力シンビオントは,出力がフォームの下マージンに達するとフォーム・フィードを挿入してページングを行う。
QUEUE_FILE_TRAILER 文字列 キューで実行した各ジョブの各ファイルの後にトレーラ・ページが続く場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_FILE_TRAILER_ONE 文字列 キューで実行した各ジョブの最後のファイルの最後コピーの後にのみトレーラ・ページが続く場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_FLAGS 整数値 指定したキューに対して選択された処理オプション。整数値はビット・フィールドを表す。フィールドの各ビット設定を確認するためには, QUEUE_FLAGS のかわりに次の項目のいずれか 1 つを使用する。
QUEUE_ACL_SPECIFIED
QUEUE_AUTOSTART
QUEUE_BATCH
QUEUE_CPU_DEFAULT
QUEUE_CPU_LIMIT
QUEUE_FILE_BURST
QUEUE_FILE_BURST_ONE
QUEUE_FILE_FLAG
QUEUE_FILE_FLAG_ONE
QUEUE_FILE_PAGINATE
QUEUE_FILE_TRAILER
QUEUE_FILE_TRAILER_ONE
QUEUE_GENERIC
QUEUE_GENERIC_SELECTION
QUEUE_JOB_BURST
QUEUE_JOB_FLAG
QUEUE_JOB_SIZE_SCHED
QUEUE_JOB_TRAILER
QUEUE_NO_INITIAL_FF
QUEUE_PRINTER
QUEUE_RECORD_BLOCKING
QUEUE_RETAIN_ALL
QUEUE_RETAIN_ERROR
QUEUE_SWAP
QUEUE_TERMINAL
QUEUE_WSDEFAULT
QUEUE_WSEXTENT
QUEUE_WSQUOTA
QUEUE_GENERIC 文字列 キューが汎用キューである場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_GENERIC_SELECTION 文字列 キューが,汎用キューから作業を受けることができる実行キューである場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_IDLE 文字列 キューが,ジョブの処理が可能であるが現在処理中でないキューである, またはキューの実行を遅らせる機能を持つ汎用キューである場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_JOB_BURST 文字列 キューで実行した各ジョブの前にバースト・ページおよびフラグ・ページを入れる場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_JOB_FLAG 文字列 キューで実行した各ジョブの前にフラグ・ページを入れる場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_JOB_SIZE_SCHED 文字列 キューで実行したジョブが,サイズに基づいて (つまり,サイズが小さいジョブの方が処理される優先順位が高いという基準にしたがって) スケジューリングされた場合は TRUE,総出ない場合は FALSE を戻す。出力キューにのみ適用される。
QUEUE_JOB_TRAILER 文字列 キューで実行した各ジョブの後にトレーラ・ページが続く場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_LOWERCASE 文字列 大文字も小文字もプリントできるプリンタにキューが関連付けられている場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_NAME 1 文字列 指定したキューの名前,または指定したジョブを含むキューの名前。
QUEUE_PAUSED 文字列 現在キューに登録されているすべてのジョブの処理が一時的に停止されている場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_PAUSING 文字列 一時的にキューが停止している場合は TRUE, そうでない場合は FALSE を戻す。一時的にキューが停止していると,現在実行中のジョブが終了しても,一時的に新しいジョブは実行できなくなる。
QUEUE_PRINTER 文字列 キューがプリンタ・キューである場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_RECORD_BLOCKING 文字列 シンビオントが連結またはブロック化して,出力レコードを出力装置に送る場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_REMOTE 文字列 キューが,ローカル・ノードに接続していない物理装置に割り当てられている場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_RESETTING 文字列 キューが再設定および停止している場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_RESUMING 文字列 キューが休止のあと再起動している場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_RETAIN_ALL 文字列 キューで実行したすべてのジョブが実行後もそのままキューにある場合は TRUE, そうでない場合は FALSE を戻す。終了したジョブは終了状態の印がつけられる。
QUEUE_RETAIN_ERROR 文字列 失敗して終了したジョブだけがキューに残っている場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_SERVER 文字列 サーバ・シンビオントに処理が指示された場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_STALLED 文字列 キューに割り当てられた物理装置が停止している (つまり,登録された最後の入出力要求が正常終了していない)場合は TRUE, 停止していない場合は FALSE を戻す。
QUEUE_STARTING 文字列 キューがスタートしている場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_STATUS 整数値 指定したキューの状態フラグ。整数値はビット・フィールドを表す。フィールドの各ビット設定を確認するためには, QUEUE_STATUS のかわりに次の項目のいずれか 1 つを使用する。
QUEUE_ALIGNING
QUEUE_AUTOSTART
QUEUE_AUTOSTART_INACTIVE
QUEUE_AVAILABLE
QUEUE_BUSY
QUEUE_CLOSED
QUEUE_IDLE
QUEUE_LOWERCASE
QUEUE_PAUSED
QUEUE_PAUSING
QUEUE_REMOTE
QUEUE_RESETTING
QUEUE_RESUMING
QUEUE_SERVER
QUEUE_STALLED
QUEUE_STARTING
QUEUE_STOP_PENDING
QUEUE_STOPPED
QUEUE_STOPPING
QUEUE_UNAVAILABLE
QUEUE_STOP_PENDING 文字列 現在実行中のジョブが終了したときにキューが停止される場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_STOPPED 文字列 キューが停止された場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_STOPPING 文字列 キューが停止しようとしている場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_SWAP 文字列 キューで実行したジョブがスワップできる場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_TERMINAL 文字列 キューがターミナル・キューである場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_UNAVAILABLE 文字列 キューに割り当てられた物理装置が使用できない場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_WSDEFAULT 文字列 キューで実行した各ジョブに対して,それぞれ省略時のワーキング・セット・サイズが指定されている場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_WSEXTENT 文字列 キューで実行した各ジョブに対して,それぞれ省略時のワーキング・セット超過値が指定されている場合は TRUE, そうでない場合は FALSE を戻す。
QUEUE_WSQUOTA 文字列 キューで実行した各ジョブに対して,それぞれ省略時のワーキング・セット制限値が指定されている場合は TRUE, そうでない場合は FALSE を戻す。
REQUEUE_QUEUE_NAME 1 文字列 指定したジョブが再割り当てされているキューの名前。
RESTART_QUEUE_NAME 1 文字列 ジョブを再スタートした場合にジョブが置かれるキューの名前。
RETAINED_JOB_COUNT 整数値 終了してキューに残っているジョブとエラーになったままのジョブを合わせた数。
SCSNODE_NAME 文字列 指定したキューで開始するジョブが実行される OpenVMS ノードの 6 バイトの名前。ノード名は,ターグット・ノードのシステム・パラメータ SCSNODE の値に一致する。
SECURITY_INACCESSIBLE 文字列 ユーザが指定したキューへの読み込みアクセス権を持っている場合は TRUE, そうでない場合は FALSE を戻す。
SUBMISSION_TIME 1 文字列 指定したジョブがキューに登録された時刻。
TIMED_RELEASE_JOB_COUNT 整数値 指定した時刻まで保留になっているジョブ数。
UIC 1 文字列 指定したジョブ所有者の利用者識別コード(UIC)。
USERNAME 1 文字列 指定したジョブ所有者のユーザ名。
WSDEFAULT 1 整数値 指定したジョブまたはキューに対して指定された省略時のワーキング・セット・サイズ。バッチ・ジョブ, 実行キュー,および出力キューにのみ適用される。
WSEXTENT 1 整数値 指定したジョブまたはキューに対して指定された省略時のワーキング・セット超過値。バッチ・ジョブ, 実行キュー,および出力キューにのみ適用される。
WSQUOTA 1 整数値 指定したジョブまたはキューに対して指定された省略時のワーキング・セット制限値。バッチ・ジョブ, 実行キュー,および出力キューにのみ適用される。


1DISPLAY_ENTRY, DISPLAY_JOB, または DISPLAY_FILE を使用する場合は,読み込み(R)アクセス権が必要です。


#1

$  BLOCKS = F$GETQUI("DISPLAY_ENTRY" ,"JOB_SIZE", 1347)

この例では,プリント・ジョブ 1347 のブロック・サイズを得るために F$GETQUI レキシカル関数が使用されています。 F$GETQUI が戻す値は,プリント・ジョブ1347 に関連するファイルが占有している総ブロック・サイズです。

#2

$ IF F$GETQUI("DISPLAY_QUEUE", "QUEUE_STOPPED", "VAX1_BATCH") .EQS. 
"TRUE" THEN GOTO 500 

この例では,F$GETQUI レキシカル関数を使用して VAX1_BATCH キューが停止状態かどうかを調べています。 VAX1_BATCH が停止状態であればTRUE,そうでなければ FALSE が戻されます。 VAX1_BATCH キューがシステムに存在しない場合は,空文字列("") が戻されます。

#3

! This command procedure shows all queues and the jobs in them. 
$  TEMP = F$GETQUI("") 
$  QLOOP: 
$  QNAME = F$GETQUI("DISPLAY_QUEUE","QUEUE_NAME","*") 
$  IF QNAME .EQS. "" THEN EXIT 
$  WRITE SYS$OUTPUT "" 
$  WRITE SYS$OUTPUT "QUEUE: ", QNAME 
$  JLOOP: 
$  NOACCESS = F$GETQUI("DISPLAY_JOB","JOB_INACCESSIBLE",,"ALL_JOBS") 
$  IF NOACCESS .EQS. "TRUE" THEN GOTO JLOOP 
$  IF NOACCESS .EQS. "" THEN GOTO QLOOP 
$  JNAME = F$GETQUI("DISPLAY_JOB","JOB_NAME",,"FREEZE_CONTEXT") 
$  WRITE SYS$OUTPUT "    JOB:  ", JNAME 
$  GOTO JLOOP 

この例は,システムのすべてのキュー,およびユーザが READ アクセスを持つすべてのジョブを表示するコマンド・プロシージャです。外側のループでは,ワイルド・カードを使用してキューの表示が実行されます。キュー情報を得る時には,アクセス権の確認は必要ありません。これは,すべてのユーザは暗黙でキュー属性への READ アクセス権を持っているからです。キュー名にワイルドカード("*")が指定されているため,キューのリスト(ワイルドカード・コンテキスト)が保持されます。

内側のループでは,すべてのジョブの情報を得るために,ワイルドカード表示キュー・モードからネストしたワイルドカードを入力しています。このループでは,ジョブに対しては暗黙の READ アクセス権は与えられていないので,ジョブ情報を得る事ができるかどうかを確認しなければなりません。ジョブに対する要求の中で FREEZE_CONTEXT キーワードを使用して,ワイルドカード・コンテキストを次のオブジェクトへ進めないないようにしています。ジョブ名が検索され表示されると,制御は次のジョブに移ります。この時には,FREEZE_CONTEXTキーワードは使用されていないので,コンテキストは次のジョブに進みます。このワイルドカード・キュー・コンテキストは,一致するキューがなくなるまで維持されます。一致するキューがなくなると,F$GETQUI は,一致するオブジェクトがこれ以上ないことを示すために,空文字列 ("") を戻します。

#4

$ THIS_NODE = F$EDIT(F$GETSYI("SCSNODE"),"COLLAPSE") 
$ TEMP = F$GETQUI("CANCEL_OPERATION") 
$ SET NOON 
$LOOP: 
$ QUEUE = F$GETQUI("DISPLAY_QUEUE","QUEUE_NAME","*","WILDCARD") 
$ IF QUEUE .EQS. "" THEN GOTO ENDLOOP 
$ IF THIS_NODE .EQS.- 
F$GETQUI("DISPLAY_QUEUE","SCSNODE_NAME","*","WILDCARD,FREEZE_CONTEXT") 
$ THEN 
$    IF .NOT.- 
  F$GETQUI("DISPLAY_QUEUE","QUEUE_AUTOSTART","*","WILDCARD,FREEZE_CONTEXT")- 
  THEN START/QUEUE 'QUEUE' 
$ ENDIF 
$ GOTO LOOP 
$ENDLOOP: 
$ SET ON 

この例は,ローカル・クラスタ・ノードに関するすべてのキューを調べ,自動起動になっていないキューを開始させるコマンド・プロシージャです。

このコマンド・プロシージャは,ローカル・システムのノード名を得て, F$GETQUI コンテキストをクリアにします。キューが既に起動している場合は, START QUEUE コマンドの結果としてこのコマンド・プロシージャが強制終了されることのないように,エラー処理を無効にしておきます。

ループ内では, F$GETQUI レキシカル関数は,キュー・リストから次のキュー名を取り出します。次のキューがない場合は,ループを終了します。

次の IF は,ローカル・ノードでキューが実行するかをチェックしています。実行する場合は,次に,キューが自動起動になっているかをチェックします。ローカル・ノードでキューが実行しない場合は, START コマンドを使用してキューを起動させます。その後,ループを繰り返します。

最後のコマンドは,DCL エラー処理を以前の設定にリストアします。


前へ 次へ 目次 索引