ControlPrintProcessor 関数 (winsplp.h)
印刷プロセッサの ControlPrintProcessor 関数を使用すると、スプーラーは印刷ジョブを制御できます。
構文
BOOL ControlPrintProcessor(
[in] HANDLE hPrintProcessor,
[in] DWORD Command
);
パラメーター
[in] hPrintProcessor
呼び出し元から提供される印刷プロセッサ ハンドル。 これは、 OpenPrintProcessor の以前の呼び出しによって返されたハンドルです。
[in] Command
実行する操作の種類を示す呼び出し元指定のコマンド。 次のコマンドが有効です。
| コマンド | 定義 |
|---|---|
| JOB_CONTROL_CANCEL | 関数は、現在の印刷ジョブを取り消す必要があります。 |
| JOB_CONTROL_PAUSE | 関数は、現在の印刷ジョブを一時停止する必要があります。 |
| JOB_CONTROL_RESUME | 関数は、現在の印刷ジョブを再開する必要があります。 |
戻り値
操作が成功した場合、関数は TRUE を返す必要があります。 操作が失敗した場合、関数は SetLastError を呼び出してエラー コードを設定し、 FALSE を返す必要があります。
注釈
ControlPrintProcessor 関数をエクスポートするには、印刷プロセッサが必要です。 スプーラーは、Microsoft Windows SDKドキュメントで説明されている SetJob 関数をアプリケーションが呼び出すときに関数を呼び出します。
Command で受け取った値に基づいて、関数は現在のジョブを一時停止、再開、または取り消す必要があります。 ControlPrintProcessor 関数は、印刷プロセッサの PrintDocumentOnPrintProcessor 関数の実行中に非同期的に呼び出すことができます。 そのため、ジョブを一時停止するように内部定義のイベント オブジェクトを設定し、ジョブが再開されたときにイベント オブジェクトをリセットするなど、何らかの同期手法を使用する必要があります。 ControlPrintProcessor 関数は、イベント オブジェクトの設定またはリセット後にすばやく戻ることができ、PrintDocumentOnPrintProcessor はイベントが適切な状態になるまで待機できます。
要件
| 要件 | 値 |
|---|---|
| 対象プラットフォーム | デスクトップ |
| Header | winsplp.h (Winsplp.h を含む) |
| Library | Nwprint.lib |