Win32 API 日本語リファレンス
ホーム › Storage.Xps.Printing › IXpsPrintJob

IXpsPrintJob

COM
📘 Microsoft Learn (日本語) · English
IID5ab89b06-8194-425f-ab3b-d7a96e350161継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

現在進行中の印刷ジョブへのアクセスを提供します。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT Cancel()

印刷ジョブをキャンセルします。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドが呼び出された時点で進行中のスプール処理または印刷処理は、すべてキャンセルされます。

この関数はスレッドセーフであり、印刷ジョブオブジェクトのジョブ状態と同期しています。

vtbl 4 HRESULT GetJobStatus(XPS_JOB_STATUS* jobStatus)

印刷ジョブの現在の状態を取得します。

jobStatusXPS_JOB_STATUS*out印刷ジョブの現在の状態。この構造体で返されるデータについては、XPS_JOB_STATUS を参照してください。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

GetJobStatus は、印刷ジョブの処理中または印刷ジョブの完了後に呼び出すことができます。XPS_JOB_STATUS で返される値は、GetJobStatus を呼び出した時点における印刷ジョブの現在の状態を表すため、このメソッドの呼び出しと呼び出しの間にある中間状態を取りこぼす可能性があります。

jobStatus.currentDocument および jobStatus.currentPage の値は、順番に進行することが保証されています。すなわち、最初のドキュメントから最後のドキュメントへ、また各ドキュメント内では最初のページから最後のページへと進みます。

Microsoft XPS Document Writer (MXDW) に送信された印刷ジョブのジョブ ID は 0 です。このインターフェイスが MXDW に送信された印刷ジョブのものである場合、jobStatus.jobId には 0 が返されます。

印刷ジョブにジョブ ID が割り当てられていない場合、またはスプールを行わずに印刷ジョブが印刷される場合は、jobStatus.jobId に 0 が返されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IXpsPrintJob "{5AB89B06-8194-425F-AB3B-D7A96E350161}"
#usecom global IXpsPrintJob IID_IXpsPrintJob "{}"
#comfunc global IXpsPrintJob_Cancel        3
#comfunc global IXpsPrintJob_GetJobStatus  4 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。