SearchJobIDプロパティ
スプールデータを検索するジョブIDを指定します。
解説
-
ジョブIDに指定できる文字列は,36バイトまでです。
-
GetSpoolFileメソッド,GetSpoolFileAttributeメソッド,PrintSpoolReportメソッド,およびSetSpoolFileAttributeメソッドを呼び出す場合に使用するときは,必ずSearchJobIDプロパティを指定してください。
-
GetSpoolFileOutlineメソッドを呼び出す場合に使用するときは,SearchJobIDプロパティの指定は任意です。
-
DeleteSpoolFileメソッドを呼び出す場合に使用するときは,DeleteKindプロパティの指定によって次のように異なります。
-
指定したジョブIDのスプールデータの削除(DeleteKind=0)のときは,必ず指定してください。
-
蓄積期限切れファイルの削除(DeleteKind=1)のときは,指定する必要はありません。
-
-
SearchJobIDプロパティは,GetSpoolFileOutlineメソッド,GetSpoolFileAttributeメソッド,SetSpoolFileAttributeメソッド,PrintSpoolReportメソッド,GetSpoolFileメソッド,およびDeleteSpoolFileメソッドでスプールデータを操作する場合,指定が有効になります。それ以外のメソッドでは,SearchJobIDプロパティを指定しても無視されます。
データ型
-
String(PrintSpoolReportメソッド,GetSpoolFileメソッド,またはDeleteSpoolFileメソッドを呼び出す場合に一つのジョブIDを指定するとき)
-
String配列(PrintSpoolReportメソッド,GetSpoolFileメソッド,またはDeleteSpoolFileメソッドを呼び出す場合に複数のジョブIDを指定するとき)
-
String(上記以外のメソッドを呼び出す場合)