12.2.1 スプールデータの一覧取得

蓄積フォルダに格納されているスプールデータの一覧を取得できます。表12-5に示す項目を設定することで,条件に当てはまるファイルを検索して取得します。

なお,一覧を取得する際は,取得する情報量に応じた処理時間が掛かります。一度に一覧に取得するスプールデータの件数は,10,000件程度までとすることを推奨します。

<この項の構成>
(1) 取得できる情報
(2) 実行メソッド
(3) 設定項目

(1) 取得できる情報

スプールデータごとに取得できる情報を次に示します。

注※
メソッドを発行した時点で,最後に印刷を実行したときの結果です。蓄積拠点サーバ印刷の場合は「印刷データをスプールへ出力した結果」を示し,蓄積クライアント印刷の場合は「印刷データをクライアントPCへ配信した結果」を示します。

(2) 実行メソッド

スプールデータの一覧取得を実行するメソッドを次の表に示します。

表12-4 スプールデータの一覧取得を実行するメソッド

起動部品メソッド
SS-ActiveX起動部品GetSpoolFileOutline
SS-Java起動部品getSpoolFileOutline
SS-コマンド起動部品(eurpmlscコマンド)/mオプションにgetoutlineを指定

(3) 設定項目

スプールデータの一覧を取得するときに設定する項目を,次の表に示します。

表12-5 スプールデータの一覧を取得するときに設定する項目

スプールデータの検索条件の設定起動部品の設定項目設定する値
スプールサーバのIPアドレスSS-ActiveX起動部品:ServerAddressプロパティ
SS-Java起動部品:setServerAddressメソッド
SS-コマンド起動部品:/svrオプション
255.255.255.255形式
検索条件ジョブIDSS-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バイト以内の文字列)
スプールデータのジョブIDSS-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個まで指定できます。設定されたジョブ検索キーをスプールデータの一覧取得時に指定することで,対象のスプールデータを検索します。検索時は,分類と値が共に一致するスプールデータを検索します。