AbortDoc

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

AbortDoc hdc

hdc : [intptr] 印刷ジョブのデバイスコンテキストへのハンドル。

(プラグイン / モジュール : gdi32.dll)

解説

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

[戻り値]
関数が成功した場合、戻り値はゼロより大きい値となる。関数が失敗した場合、戻り値は SP_ERROR となる。

[備考]
注意:
これはブロッキングまたは同期関数であり、即座に戻らないことがある。この関数がどれくらい速く戻るかは、ネットワーク状態、プリントサーバーの構成、プリンタードライバーの実装といった、アプリケーション作成時には予測しにくい実行時要因に依存する。ユーザーインターフェイスとのやり取りを管理するスレッドからこの関数を呼び出すと、アプリケーションが応答しなくなったように見えることがある。アプリケーションは、エラーが発生した場合や、ユーザーがジョブをキャンセルした後で印刷ジョブを停止するために
AbortDoc 関数を呼ぶべきである。印刷ジョブを正常に終了するには、アプリケーションは EndDoc
関数を呼ぶ。プリントマネージャーで印刷ジョブが開始されていた場合、AbortDoc
を呼ぶとスプールジョブ全体が消去され、プリンターには何も送られない。プリントマネージャーで印刷ジョブが開始されていなかった場合、データは既にプリンターへ送られている可能性がある。この場合、プリンタードライバーは（可能なら）プリンターをリセットして印刷ジョブを終了する。

情報