PFAXSENDDOCUMENTW

コールバック

シグネチャ

BOOL PFAXSENDDOCUMENTW(
    HANDLE FaxHandle,
    LPWSTR FileName,
    FAX_JOB_PARAMW* JobParams,
    FAX_COVERPAGE_INFOW* CoverpageInfo,
    DWORD* FaxJobId
);

パラメーター

フィールド	型	説明
FaxHandle	HANDLE	FaxConnectFaxServer 関数の呼び出しによって返されたファックスサーバーのハンドルを指定します。
FileName	LPWSTR	送信するファックス文書を格納したファイルの完全修飾パスと名前を含む、定数の null 終端文字列へのポインターです。パスには UNC パス、またはドライブ文字で始まるパスを指定できます。このパラメーターには、有効なローカルファイル名を指定できます。ファイルは適切に登録されたファイルの種類である必要があり、ファックスサーバーがそのファイルにアクセスできる必要があります。
JobParams	FAX_JOB_PARAMW*	ファックスサーバーがファックスを送信するために必要な情報を含む FAX_JOB_PARAM 構造体へのポインターです。この構造体には、受信者のファックス番号、送信者と受信者のデータ、省略可能な課金コード、ジョブのスケジュール情報などが含まれます。
CoverpageInfo	FAX_COVERPAGE_INFOW*	ファックス文書のカバーページに表示する個人データを含む FAX_COVERPAGE_INFO 構造体へのポインターです。カバーページが不要な場合、このパラメーターは NULL である必要があります。
FaxJobId	DWORD*	ファックスを送信するキュー済みジョブを識別する一意の番号を受け取る DWORD 変数へのポインターです。

公式ドキュメント

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

戻り値

Type: BOOL

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

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

戻り値	説明
ERROR_INVALID_PARAMETER	FaxHandle、JobParams、FileName の各パラメーターのいずれか、またはすべてが NULL です。FAX_JOB_PARAM 構造体の CallHandle メンバーで指定された呼び出しハンドルが無効です (NULL である必要があります)。または、FAX_JOB_PARAM 構造体の RecipientNumber メンバーが NULL です。
ERROR_INVALID_FUNCTION	FaxHandle パラメーターがリモート接続を指定していますが、FAX_JOB_PARAM 構造体の CallHandle メンバーが NULL ではありません。
ERROR_ACCESS_DENIED	アクセスが拒否されました。FAX_JOB_SUBMIT のアクセス権が必要です。
ERROR_FILE_NOT_FOUND	ファックスサーバーが、FileName または CoverpageInfo パラメーターで指定されたファイルを見つけられません。
ERROR_INVALID_DATA	ファックスサーバーが、FileName または CoverpageInfo パラメーターで指定されたファイルを処理できません。
ERROR_NOT_SUPPORTED	FAX_JOB_PARAM 構造体の CallHandle メンバーを使用して、音声通話をファックス送信へ引き渡そうとしました。この機能はサポートされていません。

解説(Remarks)

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

FaxSendDocument 関数は非同期に実行され、すぐに制御を返します。ファックスサーバーは、FAX_JOB_PARAM 構造体で指定された内容に従って、ファックスを送信するジョブをキューに入れます。

FaxSendDocument が成功するには、ファックスサーバーにリモートファックスプリンターがインストールされている必要があります。

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

アプリケーションから文書を送信する際、文書内のリンクによって情報の入力を求めるダイアログが表示されることがあります。数分以内にその情報要求に対応しないと、FaxSendDocument は失敗してエラーを返します。

メモ

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

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