PFAXSETJOBA
コールバックシグネチャ
BOOL PFAXSETJOBA(
HANDLE FaxHandle,
DWORD JobId,
DWORD Command,
FAX_JOB_ENTRYA* JobEntry
);パラメーター
| フィールド | 型 | 説明 |
|---|---|---|
| FaxHandle | HANDLE | FaxConnectFaxServer 関数の呼び出しによって返されたファクスサーバーのハンドルを指定します。 |
| JobId | DWORD | 変更するファクスジョブを識別する一意の番号である DWORD 変数を指定します。JobId パラメーターに使用する有効なファクスジョブ識別子を取得するには、FaxEnumJobs 関数を呼び出します。 |
| Command | DWORD | 実行するジョブコマンドを示す DWORD 変数を指定します。このパラメーターには、次のいずれかの値を指定できます。 JC_DELETE指定したファクスジョブをキャンセルします。ジョブはアクティブでも、キューに入れられた状態でもかまいません。 JC_PAUSE指定したキュー内のファクスジョブを一時停止します。ファクスジョブがアクティブな場合、ファクスサービスは、そのジョブがキューに入れられた状態に戻った時点で一時停止します。 JC_RESUME一時停止しているファクスジョブを再開します。 JC_RESTART指定したファクスジョブを再起動します。 |
| JobEntry | FAX_JOB_ENTRYA* | 使用されません。NULL を指定する必要があります。 |
公式ドキュメント
ファクスクライアントアプリケーションは、指定したファクスジョブの一時停止、再開、キャンセル、または再起動を行うために FaxSetJob 関数を呼び出します。
戻り値
型: BOOL
関数が成功すると、戻り値は 0 以外の値になります。
関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。GetLastError は次のいずれかのエラーを返すことがあります。
| 戻り値 | 説明 |
|---|---|
| アクセスが拒否されました。FAX_JOB_MANAGE アクセス権が必要です。 | |
| FaxHandle パラメーターが NULL であるか、Command、JobEntry、JobId のいずれか 1 つまたはすべてのパラメーターが無効です。 |
解説(Remarks)
アプリケーションは通常、キューに入れられたファクスジョブを管理するために FaxSetJob 関数を呼び出します。進行中のファクス送信を終了するには、FaxAbort 関数を呼び出すことができます。
詳細については、Modifying a Fax Job および Terminating a Fax Job を参照してください。
winfax.h ヘッダーは、UNICODE プリプロセッサー定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FaxSetJob を定義します。エンコーディングに依存しないエイリアスと、エンコーディングに依存するコードを混在させると、不一致によりコンパイルエラーや実行時エラーが発生することがあります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)