SPOOLED_FILE_INFO 表関数

オンライン編集

SPOOLED_FILE_INFO 表関数は、システム上のスプール・ファイルのリストを戻します。

この情報は, スプール・ファイル処理 (WRKSPLF) CL コマンドおよびスプール・ファイルのオープン・リスト (QGYOLSPL) によって戻される情報と似ています。 API。

許可: 呼び出し側は以下を備えている必要があります。

出力待ち行列が入っているライブラリーに対する *EXECUTE 権限、および
スプール・ファイルが入っている出力待ち行列に対する *USE 権限。

スキーマは QSYS2 です。

user-name、 output-queue、または user-data の複数の値に対するフィルタリングは遅くなります。

さらに、 status でのフィルタリングが遅くなります。

user-name

フィルターに掛けるユーザー・プロファイル名を含む文字ストリング。リストには, ブランクで区切られた最大 20 個の値を入れることができます。

以下の特殊値のいずれかにすることができます。

*ALL: リストはユーザー・プロファイルによってフィルター操作されません。
*現在: 現行ユーザー・プロファイルが所有するスプール・ファイルがリストに組み込まれます。これはデフォルト値。

開始タイム・スタンプ

戻される最も古いスプール・ファイルのタイム・スタンプ値。このパラメーターを省略するかヌル値を指定すると、 ending-timestamp 以下の作成タイム・スタンプを持つすべてのスプール・ファイルが返されます。

終了タイム・スタンプ

返される最新のスプール・ファイルのタイム・スタンプ値。このパラメーターを省略するか、ヌル値を指定すると、 starting-timestamp 以上の作成タイム・スタンプを持つすべてのスプール・ファイルが戻されます。

状況

フィルター操作の対象となるスプール・ファイル状況を含む文字ストリング。リストには、ブランクで区切られた 1 つ以上の状況値を入れることができます。

*ALL: スプール・ファイルは, 現在の状況に関係なくリストに組み込まれます。これはデフォルト値。
*CLOSED: ファイルはプログラムによって完全に処理されましたが, SCHEDULE (*JOBEND) が指定されています。スプール・ファイルを作成したジョブが終了していません。
* 据え置き: このスプール・ファイルは印刷から据え置かれています。
* 終了: このスプール・ファイルはもはやシステムにはありません。これらのスプール・ファイルは, 修飾ジョブ名が指定されている場合にのみ, スプール・ファイルのリストに組み込まれます。
*開催: ファイルは保留中です。
*MESSAGE (* メッセージ): このファイルには、応答を必要とするメッセージ、またはアクションを実行する必要があるメッセージがあります。
*OPEN: ファイルは完全には処理されていないため、書き出しプログラムが選択できる状態にありません。
*PENDING: このファイルは印刷の保留中 (待機中) です。
* 印刷装置: ファイルは完全にプリンターに送信されましたが、印刷完了状況が返送されていません。
*READY: ファイルは, 書き出しプログラムによって出力装置に書き出すことができます。
*SAVED: ファイルが書き込まれ、保存されました。このファイルは、解放されるまで保存されます。
* 送信中: このスプール・ファイルは送信中であるか, あるいはリモート・システムに送られています。
* 書き込み中: このファイルは現在, 書き出しプログラムによって出力装置に作成中です。

ジョブ名

修飾ジョブ名を含む文字ストリング。

以下の特殊値のいずれかにすることができます。

*: 現在のジョブ。
*ALL: 他の基準に一致するすべてのジョブが返されます。これはデフォルト値。

出力待ち行列

フィルターに掛ける出力待ち行列の名前を含む文字ストリング。出力待ち行列名は、 library-name/outq-nameの形式でなければなりません。リストには, ブランクで区切られた最大 20 個の値を入れることができます。

ライブラリー名に *LIBL または *CURLIB を指定することができます。

修飾された出力待ち行列名のリストの代わりに, 次の特殊値を使用することができます。

*ALL: スプール・ファイルは, 出力待ち行列に関係なくリストに組み込まれます。これはデフォルト値。

ユーザー・データ

フィルター操作の対象となるスプール・ファイルのユーザー指定データまたはファイル名の値を含む文字ストリング。

以下の特殊値にすることができます。

*ALL: スプール・ファイルは, ユーザー指定データの値に関係なくリストに組み込まれます。これはデフォルト値。

フォーム・タイプ (form-type)

フィルターに掛けるフォーム・タイプ値を含む文字ストリング。

以下の特殊値のいずれかにすることができます。

*ALL: スプール・ファイルは, 用紙タイプの値に関係なくリストに組み込まれます。これはデフォルト値。
*STD: 標準用紙タイプを指定したファイルだけがリストに組み込まれます。

システム名

スプール・ファイルを作成したジョブが実行されたシステムの名前を含む文字ストリング。

以下の特殊値のいずれかにすることができます。

*ALL: リストは、ジョブ・システム名に基づいてフィルタリングされません。これはデフォルト値。
*現在: 現行システムで作成されたスプール・ファイルだけが戻されます。

この関数の結果は、以下の表に示された形式の行を含むテーブルです。列はすべて NULL 可能です。

表 1. SPOOLED_FILE_INFO 表関数
列名	データ・タイプ	説明
SPOOLED_FILE_NAME	VARCHAR(10)	スプール・ファイルの名前
SPOOLED_FILE_ 番号	INTEGER	スプール・ファイルの番号
状況	VARCHAR(15)	ファイルの状況です。 CLOSED ファイルはプログラムによって完全に処理されましたが, SCHEDULE (*JOBEND) が指定されています。スプール・ファイルを作成したジョブが終了していません。 DEFERRED ファイルの印刷は据え置かれています。 DELETED このスプール・ファイルはもはやシステムにはありません。これらのスプール・ファイルは, 修飾ジョブ名が指定されている場合にのみ, スプール・ファイルのリストに組み込まれます。 HELD ファイルは保留中です。 MESSAGE WAITING このファイルには、応答または処置を必要とするメッセージがあります。 OPEN ファイルは完全に処理されておらず, 書き出しプログラムによる選択の準備ができていません。 PENDING このファイルは印刷の保留中 (待機中) です。 PRINTING ファイルは完全にプリンターに送信されましたが、印刷完了状況が返送されていません。 READY ファイルは書き出し可能な状態です。保存ファイルが書き込まれ、保存されました。このファイルは、解放されるまで保存されます。 SENDING このスプール・ファイルは送信中であるか, あるいはリモート・システムに送られています。 WRITING このファイルは現在, 書き出しプログラムによって出力装置で作成中です。
OUTPUT_PRIORITY	INTEGER	スプール・ファイルの優先順位。優先順位は 1 (最高) から 9 (最低) までです。 STATUS が DELETED の場合は、NULL 値が入ります。
CREATION_TIMESTAMP	TIMESTAMP(0)	ファイルがオープンされたときの、ローカル・ジョブ時刻に基づくタイム・スタンプ。
USER_DATA	VARCHAR(10)	ファイルを記述するユーザー指定のデータ。ユーザー指定のデータがない場合、または STATUS が DELETED の場合は、NULL 値が入ります。
サイズ	BIGINT	スプール・ファイルのサイズ (バイト数)。スプール・ファイルのサイズは, データ・ストリーム・サイズにスプール・ファイルの属性を加えたものに, スプール・ファイルのデータ・ストリームを記憶するために使用される「オーバーヘッド」記憶域を加えたものです。サイズが使用できない場合、または STATUS が DELETED の場合は、NULL 値が入ります。
TOTAL_PAGES	INTEGER	スプール・ファイルのページの合計数またはレコードの数。ページの総数が使用できない場合、または STATUS が DELETED の場合は、NULL 値が入ります。
COPIES	INTEGER	印刷するコピーの残数。 STATUS が DELETED の場合は、NULL 値が入ります。
QUALIFIED_JOB_NAME	VARCHAR(28)	スプール・ファイルを所有するジョブの修飾ジョブ名。
JOB_NAME	VARCHAR(10)	スプール・ファイルを所有するジョブの名前
JOB_USER	VARCHAR(10)	スプール・ファイルを所有するユーザーの名前。
JOB_NUMBER	VARCHAR(6)	スプール・ファイルを所有するジョブの番号
FILE_AVAILABLE	VARCHAR(8)	スプール・ファイルのスケジュール。 IMMED スプール・ファイルは即時にスケジュールされます。スプール書き出しプログラムは, スプール・ファイルを即時に処理することができます。 FILEEND スプール・ファイルはスケジュール・ファイル終了です。スプール書き出しプログラムは, クローズされるまでスプール・ファイルを処理することはできません。 *JOBEND スプール・ファイルはスケジュール・ジョブ終了です。スプール書き出しプログラムは, スプール・ファイルのジョブが終了するまでスプール・ファイルを処理することはできません。
FORM_TYPE	VARCHAR(10)	スプール・ファイル用紙タイプ。このファイルを印刷するためにプリンターにロードする用紙のタイプ。 STATUS が DELETED の場合は、NULL 値が入ります。
OUTPUT_QUEUE_LIBRARY	VARCHAR(10)	出力待ち行列が入っているライブラリー。 STATUS が DELETED の場合は、NULL 値が入ります。
OUTPUT_QUEUE	VARCHAR(10)	スプール・ファイルが置かれている出力待ち行列の名前。 STATUS が DELETED の場合は、NULL 値が入ります。
ASP_NUMBER	INTEGER	スプール・ファイルが入っている補助記憶域プール。 1はシステムASPを示します。 STATUS が DELETED の場合は、NULL 値が入ります。
SYSTEM	VARCHAR(8)	スプール・ファイルを作成したジョブが実行されたシステムの名前。
インターネット印刷プロトコル・ジョブ ID	INTEGER	ファイルが追加または移動された出力待ち行列に基づいてシステムによって割り当てられた IPP ジョブ ID。この値の範囲は 1 から 2147483647 で、特定の出力待ち行列に対して固有であることは保証されません。 STATUS が DELETED の場合は、NULL 値が入ります。

例

現行ジョブのすべてのスプール・ファイルをリストします。
```
SELECT * FROM TABLE(QSYS2.SPOOLED_FILE_INFO(JOB_NAME => '*'));
```