注意： 9.1 組み込み関数の規則 利用オプション |
この組み込み関数は、GET_SPLF_LIST_ENTRYおよびEND_RTV_SPLF_LISTと共に使用します。この組み込み関数を最初に使用して、スプール・ファイルの取得に関する選択基準を指定する必要があります。指定できる選択条件は、ユーザー名、出力待ち行列名とライブラリ、フォーム・タイプ、ユーザー・データ、およびステータスです。
このSTART_RTV_SPLF_LISTを使用して、選択基準を設定した後で、GET_SPLF_LIST_ENTRYを使用して、スプール・ファイルの詳細を取得することができます。
スプール・ファイルのリストを取り込んだ後には、END_RTV_SPLF_LISTを使用する必要があります。この組み込み関数によって、リストを閉じ、そのリストに割り当てられた記憶域を解放します。
例については、「9.109 GET_SPLF_LIST_ENTRY」を参照してください。
番号 | タイプ | 必須/任意 | 記述 | 最小長 | 最大長 | 最小小数桁数 | 最大小数桁数 |
|---|---|---|---|---|---|---|---|
1 | A | 任意 | ユーザー名 この引数には、取得するスプール・ファイルのユーザー名を指定する必要があります。値*ALLを指定すると、すべてのユーザーが選択されます。 デフォルトは*ALLです。 | 1 | 10 | ||
2 | A | 任意 | 出力待ち行列名 この引数は、出力待ち行列ライブラリと共に使用し、どの出力待ち行列からスプール・ファイルを取得するかを指定します。値*ALLを指定すると、すべての出力待ち行列が選択されます。 デフォルトは*ALLです。 | 1 | 10 | ||
3 | A | 任意 | 出力待ち行列ライブラリ この引数は、出力待ち行列名と共に使用し、どの出力待ち行列からスプール・ファイルを取得するかを指定します。 デフォルトは*LIBLです。 | 1 | 10 | ||
4 | A | 任意 | フォーム・タイプ この引数には、取得するスプール・タイプのフォーム・タイプを指定する必要があります。値*ALLを指定すると、すべてのフォーム・タイプが選択されます。 デフォルトは*ALLです。 | 1 | 10 | ||
5 | A | 任意 | ユーザー・データ この引数には、取得するスプール・タイプのユーザー・データを指定する必要があります。値*ALLを指定すると、ユーザー・データに関係なくスプール・ファイルが選択されます。 デフォルトは*ALLです。 | 1 | 10 | ||
6 | A | 任意 | ステータス この引数には、選択するスプール・ファイルのステータスを指定する必要があります。 デフォルトは*ALLです。 指定可能な値は、*ALL、*CLOSED、*DEFERRED、*SENDING、*FINISHED、*HELD、*MESSAGE、*OPEN、*PENDING、*PRINTING、*READY、*SAVED、*WRITINGです。 | 1 | 10 |
番号 | タイプ | 必須/任意 | 記述 | 最小長 | 最大長 | 最小小数桁数 | 最大小数桁数 |
|---|---|---|---|---|---|---|---|
1 | A | 任意 | 戻りコード OK = リストが正常に開かれた ER = 引数の選択詳細が無効 NR = 選択引数に一致するスプール・ファイルが見つからない | 2 | 2 |