ホーム › Devices.Fax › PFAXSENDDOCUMENTFORBROADCASTA

PFAXSENDDOCUMENTFORBROADCASTA

コールバック

シグネチャ

BOOL PFAXSENDDOCUMENTFORBROADCASTA(
    HANDLE FaxHandle,
    LPSTR FileName,
    DWORD* FaxJobId,
    PFAX_RECIPIENT_CALLBACKA FaxRecipientCallback,
    void* Context
);

パラメーター

フィールド	型	説明
FaxHandle	HANDLE	FaxConnectFaxServer 関数の呼び出しによって返されたファクスサーバーのハンドルを指定します。
FileName	LPSTR	すべての受信者に送信するファクス文書を格納したファイルの、完全修飾パスと名前を含む定数の null 終端文字列へのポインターです。パスには UNC パス、またはドライブ文字で始まるパスを指定できます。このパラメーターには、有効なローカルファイル名を指定できます。ファイルは適切に登録されたファイルの種類である必要があり、ファクスサーバーがそのファイルにアクセスできる必要があります。
FaxJobId	DWORD*	ファクス送信を行うキュー済みジョブを識別する一意の番号を受け取る、DWORD 変数へのポインターです。
FaxRecipientCallback	PFAX_RECIPIENT_CALLBACKA	ファクス送信の指定された受信者ごとに、ユーザー固有の情報を取得する FAX_RECIPIENT_CALLBACK 関数へのポインターです。FaxSendDocumentForBroadcast 関数は、FAX_RECIPIENT_CALLBACK 関数が 0 を返すまで、ファクス受信者ごとに 1 回ずつこの関数を呼び出します。0 は、すべての送信がキューに入れられたことを示します。
Context	void*	アプリケーション固有のコンテキスト情報、またはアプリケーション定義の値を格納する変数へのポインターです。FaxSendDocumentForBroadcast は、このデータを FAX_RECIPIENT_CALLBACK 関数に渡します。

公式ドキュメント

ファクスクライアントアプリケーションは、同一の送信ファクスを複数の受信者へ送信する複数のファクスジョブをキューに入れるために、FaxSendDocumentForBroadcast 関数を呼び出します。

戻り値

型: BOOL

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

関数が失敗すると、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。GetLastError は、次のいずれかのエラーを返すことがあります。

戻り値	説明
ERROR_INVALID_PARAMETER	FaxHandle、FileName、FaxRecipientCallback、FaxJobId の各パラメーターのいずれか、またはすべてが NULL であるか、FAX_JOB_PARAM 構造体の RecipientNumber メンバーが NULL です。
ERROR_FILE_NOT_FOUND	ファクスサーバーが、FileName パラメーターで指定されたファイルを見つけられません。
ERROR_INVALID_DATA	ファクスサーバーが、FileName パラメーターで指定されたファイルをレンダリングできません。
ERROR_ACCESS_DENIED	アクセスが拒否されました。FAX_JOB_SUBMIT アクセス権が必要です。

解説(Remarks)

この関数は、指定されたファクス受信者ごとに 1 回ずつ FAX_RECIPIENT_CALLBACK 関数を呼び出します。

複数の受信者にファクス文書を効率よく送信するには、FaxSendDocument を複数回呼び出すのではなく、FaxSendDocumentForBroadcast 関数を呼び出します。これは、FaxSendDocumentForBroadcast がマスター文書を 1 回だけ保存し、すべての送信で同じファイルを使用するためです。

注複数の受信者にファクス文書を効率よく送信するには、アプリケーションは FaxSendDocument 関数を複数回呼び出す必要があります。FaxSendDocumentForBroadcast 関数は、下位互換性のためにサポートされています。

FaxSendDocumentForBroadcast 関数は、次の処理を示された順に実行します。

この関数は、複数のファクス受信者へ送信するためにマスター文書をキューに入れます。
この関数は、ユーザー定義の FAX_RECIPIENT_CALLBACK 関数を呼び出します。コールバック関数がファクス受信者への送信に必要な情報を提供した場合、0 以外の値を返します。この値は、FaxSendDocumentForBroadcast がそのデータを使用して送信ファクスをキューに入れるべきであることを示します。
この関数は、マスター文書を使用して最初の受信者へのファクス送信ジョブをキューに入れます。
この関数は、FAX_RECIPIENT_CALLBACK 関数を、0 が返されるまで繰り返し呼び出します。FAX_RECIPIENT_CALLBACK が 0 以外を返すたびに、FaxSendDocumentForBroadcast 関数は次のファクス受信者への送信をキューに入れます。0 は、キューに入れるファクス送信ジョブがこれ以上なく、FAX_RECIPIENT_CALLBACK の呼び出しを終了すべきであることを示します。

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

メモ

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

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