PFAXROUTEENUMFILE

コールバック

シグネチャ

BOOL PFAXROUTEENUMFILE(
    DWORD JobId,
    GUID* GuidOwner,
    GUID* GuidCaller,
    LPWSTR FileName,
    void* Context
);

パラメーター

フィールド	型	説明
JobId	DWORD	ファクスドキュメントを受信したファクスジョブを識別する一意の番号を指定します。
GuidOwner	GUID*	ファクスファイルリストにファイルを追加したファクスルーティングメソッドに関連付けられた GUID へのポインターです (このファイルは FileName パラメーターで指定されます)。
GuidCaller	GUID*	FaxRouteEnumFiles 関数を呼び出したファクスルーティングメソッドに関連付けられた GUID へのポインターです (FaxRouteEnumFiles は FaxRouteEnumFile 関数へのポインターを渡します)。このパラメーターは FaxRouteEnumFiles の Guid パラメーターと同じ値になることに注意してください。GuidCaller パラメーターは NULL にすることができます。
FileName	LPWSTR	null で終わる定数 Unicode 文字列へのポインターです。ファクスサービスは、受信したファクスドキュメントに関連付けられたファクスファイルリスト内の 1 つのファイルの完全修飾パスと名前をこの変数に設定します。
Context	void*	GuidCaller パラメーターで識別されるファクスルーティングメソッドから提供された、拡張機能定義の値へのポインターです。これは、FaxRouteEnumFiles 関数が FaxRouteEnumFile に渡す不透明な値です。

公式ドキュメント

FaxRouteEnumFile コールバック関数は、受信したファクスドキュメントに関連付けられたファクスファイルリスト内のファイル名を受け取ります。この関数は、受信したファクスドキュメントに関連付けられたファクスファイルリスト内のファイル名を受け取り、ルーティング拡張機能によって定義された処理を実行します。ファクスファイルリスト内の次のファイル名に進むには 0 以外の値を返し、FaxRouteEnumFiles を停止するには 0 を返します。

FaxRouteEnumFile は、ファクスルーティング拡張 DLL によって定義される関数名のプレースホルダーです。PFAXROUTEENUMFILE データ型は、FaxRouteEnumFile 関数へのポインターです。

戻り値

Type: BOOL

この関数は、列挙を継続するには 0 以外の値を返し、列挙を停止するには 0 を返します。

解説(Remarks)

ファクスルーティング拡張 DLL は、FaxRouteEnumFile コールバック関数のアドレスを FaxRouteEnumFiles 関数に渡すことで、このコールバック関数を登録する必要があります。

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

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