ホーム › Devices.Fax › PFAXSENDDOCUMENTFORBROADCASTW

PFAXSENDDOCUMENTFORBROADCASTW

コールバック

シグネチャ

BOOL PFAXSENDDOCUMENTFORBROADCASTW(
    HANDLE FaxHandle,
    LPWSTR FileName,
    DWORD* FaxJobId,
    PFAX_RECIPIENT_CALLBACKW FaxRecipientCallback,
    void* Context
);

パラメーター

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

公式ドキュメント

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

戻り値

Type: 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 がそのデータを使用して送信ファックスをキューに入れる必要があることを示します。
マスタードキュメントを使用して、最初の受信者へのファックス送信ジョブをキューに入れます。
0 が返されるまで、FAX_RECIPIENT_CALLBACK 関数を繰り返し呼び出します。FAX_RECIPIENT_CALLBACK が 0 以外の値を返すたびに、FaxSendDocumentForBroadcast 関数は次のファックス受信者への送信をキューに入れます。0 は、キューに入れるファックス送信ジョブがこれ以上なく、FAX_RECIPIENT_CALLBACK の呼び出しを終了すべきであることを示します。

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

メモ

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

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