13.2.1 スプールデータの一覧取得
蓄積フォルダに格納されているスプールデータの一覧を取得できます。「(3) 設定項目」に示す項目を設定することで，条件に当てはまるファイルを検索して取得します。
なお，一覧を取得する際は，取得する情報量に応じた処理時間が掛かります。一度に一覧に取得するスプールデータの件数は，10,000件程度までとすることを推奨します。
- 〈この項の構成〉
(1) 取得できる情報
スプールデータごとに取得できる情報を次に示します。
-
蓄積フォルダからの相対パス
-
スプールデータに格納された印刷データのファイル名
-
スプールデータに格納された印刷データのページ数
-
作成日時
-
印刷結果 ※
-
プリンタクラス名
- 注※
-
メソッドを発行した時点で，最後に印刷を実行したときの結果です。蓄積拠点サーバ印刷の場合は「印刷データをスプールへ出力した結果」を示し，蓄積クライアント印刷の場合は「印刷データをクライアントPCへ配信した結果」を示します。
(2) 実行メソッド
スプールデータの一覧取得を実行するメソッドを次の表に示します。
|
起動部品 |
メソッド |
|---|---|
|
SS-ActiveX起動部品 |
GetSpoolFileOutline |
|
SS-Java起動部品 |
getSpoolFileOutline |
|
SS-コマンド起動部品（eurpmlscコマンド） |
/mオプションにgetoutlineを指定 |
(3) 設定項目
スプールデータの一覧を取得するときに設定する項目を，次の表に示します。
|
スプールデータの検索条件の設定 |
起動部品の設定項目 |
設定する値 |
|
|---|---|---|---|
|
スプールサーバのIPアドレス |
SS-ActiveX起動部品：ServerAddressプロパティ SS-Java起動部品：setServerAddressメソッド SS-コマンド起動部品：/svrオプション |
255.255.255.255形式 |
|
|
検索条件 |
ジョブID |
SS-ActiveX起動部品：SearchJobIDプロパティ SS-Java起動部品：setSearchJobIDメソッド，またはsetSearchJobIDMultiメソッド SS-コマンド起動部品：/idオプション |
ジョブID（36バイト以内の文字列） |
|
スプールデータに格納された印刷データのファイル名 |
SS-ActiveX起動部品：SearchSpoolFileNameプロパティ SS-Java起動部品：setSearchSpoolFileNameメソッド SS-コマンド起動部品：/incオプション |
格納ファイル名（255バイト以内の文字列） |
|
|
プリンタクラス名 |
SS-ActiveX起動部品：SearchPrinterClassNameプロパティ SS-Java起動部品：setSearchPrinterClassNameメソッド SS-コマンド起動部品：/pcオプション |
プリンタクラス名（80バイト以内の文字列） |
|
|
ファイル作成日時の範囲（開始） |
SS-ActiveX起動部品：SearchCreateTimeStartプロパティ SS-Java起動部品：setSearchCreateTimeStartメソッド SS-コマンド起動部品：/tsオプション |
YYYYMMDDhhmmss形式 |
|
|
ファイル作成日時の範囲（終了） |
SS-ActiveX起動部品：SearchCreateTimeEndプロパティ SS-Java起動部品：setSearchCreateTimeEndメソッド SS-コマンド起動部品：/teオプション |
YYYYMMDDhhmmss形式 |
|
|
ジョブ検索キー※の分類 |
SS-ActiveX起動部品：SearchJobKeyCategoryプロパティ SS-Java起動部品：setSearchJobKeyCategoryメソッド SS-コマンド起動部品：/fcオプション |
ジョブ検索キーの分類（80バイト以内の文字列） |
|
|
ジョブ検索キー※ |
SS-ActiveX起動部品：SearchJobKeyDataプロパティ SS-Java起動部品：setSearchJobKeyDataメソッド SS-コマンド起動部品：/fdオプション |
ジョブ検索キー（80バイト以内の文字列） |
|
|
スプールデータのジョブID |
SS-ActiveX起動部品：SearchJobIDプロパティ SS-Java起動部品：setSearchJobIDメソッド，またはsetSearchJobIDMultiメソッド SS-コマンド起動部品：/idオプション |
ジョブID（36バイト以内の文字列） |
|
|
宛先キーの分類 |
SS-ActiveX起動部品：SearchReportAddressKeyCategoryプロパティ SS-Java起動部品：setSearchReportAddressKeyCategoryメソッド SS-コマンド起動部品：/racオプション |
宛先キーの分類（80バイト以内の文字列） |
|
|
宛先キーの値 |
SS-ActiveX起動部品：SearchReportAddressKeyDataプロパティ SS-Java起動部品：setSearchReportAddressKeyDataメソッド SS-コマンド起動部品：/radオプション |
宛先キーの値（80バイト以内の文字列） |
|
- 注※
-
ジョブ検索キーは，スプールデータに対してユーザが任意で設定できる検索項目です。蓄積するときに，検索キーの分類と値をペアにして，10個まで指定できます。設定されたジョブ検索キーをスプールデータの一覧取得時に指定することで，対象のスプールデータを検索します。検索時は，分類と値が共に一致するスプールデータを検索します。