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

PFAX_RECIPIENT_CALLBACKW

コールバック

シグネチャ

BOOL PFAX_RECIPIENT_CALLBACKW(
    HANDLE FaxHandle,
    DWORD RecipientNumber,
    void* Context,
    FAX_JOB_PARAMW* JobParams,
    FAX_COVERPAGE_INFOW* CoverpageInfo
);

パラメーター

フィールド型説明
FaxHandleHANDLEFaxConnectFaxServer 関数の呼び出しによって返された FAX サーバーのハンドルを指定します。
RecipientNumberDWORDFaxSendDocumentForBroadcast 関数が FAX_RECIPIENT_CALLBACK 関数を呼び出した回数を示す DWORD 変数を指定します。各呼び出しは指定された 1 件の FAX 受信者に対応し、インデックスは 1 から始まります。
Contextvoid*アプリケーション固有のコンテキスト情報、またはアプリケーション定義の値を格納する変数へのポインター。FaxSendDocumentForBroadcast は、このデータを FAX_RECIPIENT_CALLBACK 関数に渡します。
JobParamsFAX_JOB_PARAMW*FAX サーバーが指定された受信者へ FAX 送信を行うために必要な情報を格納する FAX_JOB_PARAM 構造体へのポインター。この構造体には、受信者の FAX 番号、送信者と受信者のデータ、省略可能な課金コード、ジョブのスケジュール情報などが含まれます。FAX サーバーは、FAX_JOB_PARAM 構造体で指定された内容に従って FAX 送信をキューに登録します。
CoverpageInfoFAX_COVERPAGE_INFOW*指定された受信者向けの FAX 文書のカバーページに表示するカバーページ データを格納する FAX_COVERPAGE_INFO 構造体へのポインター。カバーページが不要な場合、このパラメーターは NULL でなければなりません。

公式ドキュメント

FAX_RECIPIENT_CALLBACK 関数は、FaxSendDocumentForBroadcast 関数が送信用のユーザー固有の情報を取得するために呼び出す、アプリケーション定義またはライブラリ定義のコールバック関数です。

戻り値

型: BOOL

この関数が 0 以外の値を返した場合、FaxSendDocumentForBroadcast 関数が JobParams および CoverpageInfo パラメーターが指すデータを使用して送信 FAX をキューに登録することを示します。

この関数が 0 を返した場合、キューに登録する FAX 送信ジョブがこれ以上存在せず、FAX_RECIPIENT_CALLBACK の呼び出しを終了すべきであることを示します。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

FaxSendDocumentForBroadcast は、指定された FAX 受信者ごとに 1 回ずつ、FAX_RECIPIENT_CALLBACK を複数回呼び出します。

PFAX_RECIPIENT_CALLBACK データ型は、FAX_RECIPIENT_CALLBACK 関数へのポインターです。

FAX_RECIPIENT_CALLBACK 関数を呼び出す前に、FaxCompleteJobParams 関数を呼び出してください。FaxCompleteJobParams は、FAX_COVERPAGE_INFO 構造体と FAX_JOB_PARAM 構造体の複数のメンバーに、送信者の名前、FAX 番号、省略可能な課金コード情報などを設定するユーティリティ関数です。

FAX クライアント アプリケーションは、FaxSendDocumentForBroadcast 関数を呼び出す際に FAX_RECIPIENT_CALLBACK 関数のアドレスを渡すことで、この関数を指定する必要があります。

詳細については、Transmitting Faxes を参照してください。

メモ

winfax.h ヘッダーは、PFAX_RECIPIENT_CALLBACK を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在させると、不一致が生じ、コンパイル エラーや実行時エラーの原因となる場合があります。詳細については、関数プロトタイプの規則 を参照してください。

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