ReportJobProcessingProgress 関数

  • [アーティクル]

XPS 印刷ジョブがスプーリング段階かレンダリング フェーズか、および処理の現在進行中の部分かを、印刷スプーラー サービスに報告します。

構文

HRESULT ReportJobProcessingProgress(
  _In_ HANDLE                printerHandle,
  _In_ ULONG                 jobId,
       EPrintXPSJobOperation jobOperation,
       EPrintXPSJobProgress  jobProgress
);

パラメーター

printerHandle [in]

関数が情報を取得するプリンター ハンドル。 プリンター ハンドルを取得するには 、OpenPrinter または AddPrinter 関数を使用します。

jobId [in]

データを取得する印刷ジョブを識別します。 印刷ジョブ識別子を取得するには、 AddJob 関数または StartDoc 関数を使用します。

jobOperation

ジョブがスプーリング フェーズかレンダリング フェーズかを指定します。

jobProgress

現在処理中の処理の部分を指定します。 この値は、 jobOperation の値に応じて、スプーリング フェーズまたはレンダリング フェーズのイベントを参照します。

戻り値

操作が成功した場合、戻り値はS_OK。それ以外の場合、 HRESULT にはエラー コードが含まれます。

COM エラー コードの詳細については、「エラー 処理」を参照してください。

注釈

注意

これはブロック関数または同期関数であり、すぐには返されない可能性があります。 この関数が返す速度は、ネットワーク状態、プリント サーバーの構成、プリンター ドライバーの実装要因など、アプリケーションの作成時に予測が困難な実行時の要因によって異なります。 ユーザー インターフェイスとの対話を管理するスレッドからこの関数を呼び出すと、アプリケーションが応答しなくなる可能性があります。

注意

ReportJobProcessingProgress は、印刷ジョブがスプールまたはレンダリング フェーズにある場合にのみ、XPS 印刷ジョブの進行状況を報告します。 XPS 印刷ジョブがスプールまたはレンダリング フェーズに含まれていないときに ReportJobProcessingProgress が呼び出されると失敗します。

要件

要件 値
サポートされている最小のクライアント
 Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー
 Windows Server 2008 [デスクトップ アプリのみ]
Header
Winspool.h (Windows.h を含む)
ライブラリ
Winspool.lib
[DLL]
Spoolss.dll

関連項目

印刷

印刷スプーラー API 関数

EPrintXPSJobOperation

EPrintXPSJobProgress