PFAXABORT

コールバック

シグネチャ

BOOL PFAXABORT(
    HANDLE FaxHandle,
    DWORD JobId
);

パラメーター

フィールド	型	説明
FaxHandle	HANDLE	FaxConnectFaxServer 関数の呼び出しによって返されたファクスサーバーのハンドルを指定します。
JobId	DWORD	終了するファクスジョブを識別する一意の番号を指定します。

公式ドキュメント

ファクスクライアントアプリケーションは、ファクスジョブを終了するために FaxAbort 関数を呼び出します。

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。GetLastError は次のいずれかのエラーを返すことがあります。

リターンコード	説明
ERROR_ACCESS_DENIED	アクセスが拒否されました。ジョブの所有者であるか、FAX_JOB_MANAGE アクセス権を持っている必要があります。
ERROR_INVALID_HANDLE	FaxHandle パラメーターが無効です。
ERROR_INVALID_PARAMETER	JobId パラメーターが無効です。

解説(Remarks)

アプリケーションは通常、進行中のファクス送信を終了するために FaxAbort 関数を呼び出します。キューに入れられたファクスジョブを管理するには、アプリケーションは通常 FaxSetJob 関数を呼び出します。FaxSetJob はアクティブなジョブをキャンセルできるほか、キューに入れられたファクスジョブの一時停止、再開、キャンセル、再実行も行えます。

JobId パラメーターに使用する有効な値を取得するには、FaxEnumJobs 関数を呼び出します。

詳細については、ファクスジョブの変更およびファクスジョブの終了を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)