Win32 API 日本語リファレンス
ホーム › Devices.Fax › PFAXSETJOBW

PFAXSETJOBW

コールバック

シグネチャ

BOOL PFAXSETJOBW(
    HANDLE FaxHandle,
    DWORD JobId,
    DWORD Command,
    FAX_JOB_ENTRYW* JobEntry
);

パラメーター

フィールド型説明
FaxHandleHANDLEFaxConnectFaxServer 関数の呼び出しによって返されたファクスサーバーのハンドルを指定します。
JobIdDWORD変更対象のファクスジョブを識別する一意の番号である DWORD 変数を指定します。JobId パラメーターに使用する有効なファクスジョブ識別子を取得するには、FaxEnumJobs 関数を呼び出します。
CommandDWORD

実行するジョブコマンドを示す DWORD 変数を指定します。このパラメーターには、次のいずれかの値を指定できます。

JC_DELETE

指定したファクスジョブをキャンセルします。ジョブはアクティブでもキューに入っていてもかまいません。

JC_PAUSE

キューに入っている指定のファクスジョブを一時停止します。ファクスジョブがアクティブな場合、ファクスサービスはそのジョブがキュー状態に戻った時点で一時停止します。

JC_RESUME

一時停止しているファクスジョブを再開します。

JC_RESTART

指定したファクスジョブを再実行します。

JobEntryFAX_JOB_ENTRYW*

使用されません。NULL を指定する必要があります。

- Command.JC_DELETE

指定したファクスジョブをキャンセルします。ジョブはアクティブでもキューに入っていてもかまいません。

- Command.JC_PAUSE

キューに入っている指定のファクスジョブを一時停止します。ファクスジョブがアクティブな場合、ファクスサービスはそのジョブがキュー状態に戻った時点で一時停止します。

- Command.JC_RESTART

指定したファクスジョブを再実行します。

- Command.JC_RESUME

一時停止しているファクスジョブを再開します。

公式ドキュメント

ファクスクライアントアプリケーションは、指定したファクスジョブの一時停止、再開、キャンセル、または再実行を行うために FaxSetJob 関数を呼び出します。

戻り値

型: BOOL

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

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

戻り値 説明
ERROR_ACCESS_DENIED
 アクセスが拒否されました。FAX_JOB_MANAGE アクセス権が必要です。
ERROR_INVALID_PARAMETER
 FaxHandle パラメーターが NULL であるか、Command、JobEntry、JobId パラメーターのいずれか、またはすべてが無効です。

解説(Remarks)

アプリケーションは通常、キューに入っているファクスジョブを管理するために FaxSetJob 関数を呼び出します。進行中のファクス送信を終了するには、アプリケーションから FaxAbort 関数を呼び出します。

詳細については、Modifying a Fax Job および Terminating a Fax Job を参照してください。

メモ

winfax.h ヘッダーは、UNICODE プリプロセッサ定数の定義に応じてこの関数の ANSI 版と Unicode 版を自動的に選択するエイリアスとして FaxSetJob を定義します。エンコーディング非依存のエイリアスと、エンコーディング非依存でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因になることがあります。詳細については、Conventions for Function Prototypes を参照してください。

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