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

ABORTPROC

コールバック

シグネチャ

BOOL ABORTPROC(
    HDC param0,
    INT param1
);

パラメーター

フィールド型説明
param0HDC
param1INT

- hdc [in]

印刷ジョブのデバイスコンテキストへのハンドルです。

- iError [in]

エラーが発生したかどうかを示します。エラーが発生していない場合、このパラメーターは 0 です。印刷マネージャーのディスク領域が現在不足しており、アプリケーションが待機すればディスク領域が利用可能になる場合は SP_OUTOFDISK になります。

公式ドキュメント

AbortProc 関数は、SetAbortProc 関数と共に使用されるアプリケーション定義のコールバック関数です。この関数は、スプール中に印刷ジョブをキャンセルする必要が生じたときに呼び出されます。ABORTPROC 型は、このコールバック関数へのポインターを定義します。AbortProc は、アプリケーション定義の関数名のプレースホルダーです。

戻り値

コールバック関数は、印刷ジョブを続行する場合は TRUE を、印刷ジョブをキャンセルする場合は FALSE を返します。

解説(Remarks)

注意 これはブロッキング関数(同期関数)であり、すぐに制御を返さないことがあります。この関数が戻るまでの時間は、ネットワークの状態、プリントサーバーの構成、プリンタードライバーの実装など、アプリケーションの作成時には予測が難しい実行時の要因に左右されます。ユーザーインターフェイスとのやり取りを管理するスレッドからこの関数を呼び出すと、アプリケーションが応答していないように見えることがあります。
iError パラメーターが SP_OUTOFDISK の場合、アプリケーションは印刷ジョブをキャンセルする必要はありません。キャンセルしない場合は、PeekMessage 関数または GetMessage 関数を呼び出して、印刷マネージャーに制御を譲る必要があります。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)