PFAXCOMPLETEJOBPARAMSW
コールバックシグネチャ
BOOL PFAXCOMPLETEJOBPARAMSW(
FAX_JOB_PARAMW** JobParams,
FAX_COVERPAGE_INFOW** CoverpageInfo
);パラメーター
| フィールド | 型 | 説明 |
|---|---|---|
| JobParams | FAX_JOB_PARAMW** | FAX_JOB_PARAM 構造体を格納するバッファーのアドレスへのポインターです。出力時、この構造体には FAX サーバーから取得できる値が設定されたメンバーが格納されます。 |
| CoverpageInfo | FAX_COVERPAGE_INFOW** | FAX_COVERPAGE_INFO 構造体を格納するバッファーのアドレスへのポインターです。出力時、この構造体には FAX サーバーから取得できる値が設定されたメンバーが格納されます。 |
公式ドキュメント
FaxCompleteJobParams 関数は、FAX クライアントアプリケーションのために FAX_COVERPAGE_INFO 構造体と FAX_JOB_PARAM 構造体の両方を作成します。このユーティリティ関数は、これらの構造体の複数のメンバーに、構造体のサイズ、送信者名、および省略可能な課金コード情報の値を設定します。
戻り値
型: BOOL
関数が成功すると、戻り値は 0 以外の値になります。
関数が失敗すると、戻り値は 0 になります。
解説(Remarks)
FAX クライアントアプリケーションは、FaxSendDocument 関数を呼び出す前に FaxCompleteJobParams 関数を呼び出してください。これにより、FAX サーバーが FAX_JOB_PARAM 構造体および FAX_COVERPAGE_INFO 構造体のメンバーに対して利用可能な値を提供できるようになります。この情報の格納場所は変更される可能性があるため、アプリケーションがユーザーのレジストリに問い合わせて取得することは避けてください。詳細については、「Transmitting Faxes」を参照してください。
アプリケーションは、FaxFreeBuffer 関数を呼び出して JobParams パラメーターが指すバッファーを解放し、さらにもう一度呼び出して CoverpageInfo パラメーターが指すバッファーを解放する必要があります。詳細については、「Freeing Fax Resources」を参照してください。
winfax.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FaxCompleteJobParams を定義しています。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)