PFAXROUTEGETFILE

コールバック

シグネチャ

BOOL PFAXROUTEGETFILE(
    DWORD JobId,
    DWORD Index,
    LPWSTR FileNameBuffer,
    DWORD* RequiredSize
);

パラメーター

フィールド	型	説明
JobId	DWORD	ファックス文書を受信したファックスジョブを識別する一意の番号を指定します。
Index	DWORD	要求されたファイルを識別する一意の番号を指定します。
FileNameBuffer	LPWSTR	要求されたファイル名を格納する、null で終わる Unicode 文字列を受け取るバッファーへのポインターです。詳細については、後述の「解説」セクションを参照してください。
RequiredSize	DWORD*	符号なし DWORD 変数へのポインターです。FileNameBuffer パラメーターが NULL の場合、FileNameBuffer パラメーターが指すバッファーに必要なサイズ (バイト単位) を受け取ります。FileNameBuffer パラメーターが NULL でない場合、この変数は出力バッファーのサイズを示します。詳細については、後述の「解説」セクションを参照してください。

公式ドキュメント

ファックスルーティングメソッドは、受信したファックス文書に関連付けられたファックスファイルリストから特定のファイルの名前を取得するために、FaxRouteGetFile コールバック関数を呼び出します。

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するために、ファックスサービスは GetLastError を呼び出します。

解説(Remarks)

ファックスルーティングメソッドは、FaxRouteGetFile 関数を 2 回呼び出す必要があります。1 回目にルーティングメソッドが FaxRouteGetFile を呼び出すときは、FileNameBuffer パラメーターに null ポインターを渡す必要があります。ファックスサービスは、RequiredSize パラメーターに FileNameBuffer パラメーターに必要なサイズを設定します。ファックスルーティングメソッドは、FaxRouteInitialize 関数で指定されたヒープからバッファーに必要なメモリを割り当て、FaxRouteGetFile を再度呼び出す必要があります。2 回目にルーティングメソッドが FaxRouteGetFile を呼び出すときは、FileNameBuffer パラメーターに有効なポインターを渡す必要があります。

ファックスサービスは、FaxRouteInitialize を呼び出すときに、FaxRouteGetFile コールバック関数へのポインターを渡します。サービスは、そのポインターを FAX_ROUTE_CALLBACKROUTINES 構造体で渡します。

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

詳細については、「Fax File Lists」を参照してください。

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