ホーム › Devices.Fax › PFAX_RECIPIENT_CALLBACKA

PFAX_RECIPIENT_CALLBACKA

コールバック

シグネチャ

BOOL PFAX_RECIPIENT_CALLBACKA(
    HANDLE FaxHandle,
    DWORD RecipientNumber,
    void* Context,
    FAX_JOB_PARAMA* JobParams,
    FAX_COVERPAGE_INFOA* CoverpageInfo
);

パラメーター

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

公式ドキュメント

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

戻り値

型: BOOL

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

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

解説(Remarks)

FaxSendDocumentForBroadcast は、指定された各ファックス受信者に対して 1 回ずつ、FAX_RECIPIENT_CALLBACK を複数回呼び出します。

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

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

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

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

メモ

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

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