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

PFAXCOMPLETEJOBPARAMSA

コールバック

シグネチャ

BOOL PFAXCOMPLETEJOBPARAMSA(
    FAX_JOB_PARAMA** JobParams,
    FAX_COVERPAGE_INFOA** CoverpageInfo
);

パラメーター

フィールド型説明
JobParamsFAX_JOB_PARAMA**FAX_JOB_PARAM 構造体を格納するバッファーのアドレスへのポインターです。出力時、この構造体には、ファックスサーバーから取得できる値を持つメンバーが格納されます。
CoverpageInfoFAX_COVERPAGE_INFOA**FAX_COVERPAGE_INFO 構造体を格納するバッファーのアドレスへのポインターです。出力時、この構造体には、ファックスサーバーから取得できる値を持つメンバーが格納されます。

公式ドキュメント

FaxCompleteJobParams 関数は、ファックスクライアントアプリケーションのために FAX_COVERPAGE_INFO 構造体と FAX_JOB_PARAM 構造体の両方を作成します。このユーティリティ関数は、構造体のサイズ、送信者名、および省略可能な課金コード情報の値を、これらの構造体の複数のメンバーに設定します。

戻り値

型: BOOL

関数が成功すると、戻り値は 0 以外の値になります。

関数が失敗すると、戻り値は 0 になります。

解説(Remarks)

ファックスクライアントアプリケーションは、FaxSendDocument 関数を呼び出す前に、FaxCompleteJobParams 関数を呼び出してください。これにより、ファックスサーバーは 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 の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)