AbortDoc 関数 (wingdi.h)

AbortDoc 関数は、現在の印刷ジョブを停止し、StartDoc 関数の最後の呼び出し以降に描画されたすべてを消去します。

構文

int AbortDoc(
  [in] HDC hdc
);

パラメーター

[in] hdc

印刷ジョブのデバイス コンテキストを処理します。

戻り値

関数が成功した場合、戻り値は 0 より大きくなります。

関数が失敗した場合、戻り値はSP_ERROR。

注釈

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

 

アプリケーションは AbortDoc 関数を呼び出して、エラーが発生した場合に印刷ジョブを停止するか、ユーザーがそのジョブを取り消した後に印刷ジョブを停止する必要があります。 印刷ジョブを正常に終了するには、アプリケーションで EndDoc 関数を呼び出す必要があります。

印刷マネージャーを使用して印刷ジョブを開始した場合、 AbortDoc を呼び出すとスプール ジョブ全体が消去され、プリンターは何も受信しません。 印刷マネージャーを使用して印刷ジョブを開始しなかった場合、データは既にプリンターに送信されている可能性があります。 この場合、プリンター ドライバーはプリンターをリセットし (可能な場合)、印刷ジョブを終了します。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	wingdi.h (Windows.h を含む)
Library	Gdi32.lib
[DLL]	Gdi32.dll

こちらもご覧ください

EndDoc

印刷スプーラー API 関数

印刷

SetAbortProc

Startdoc