Win32 API 日本語リファレンス
ホーム › Devices.Fax › PFAXROUTEENUMFILES

PFAXROUTEENUMFILES

コールバック

シグネチャ

BOOL PFAXROUTEENUMFILES(
    DWORD JobId,
    GUID* Guid,
    PFAXROUTEENUMFILE FileEnumerator,
    void* Context
);

パラメーター

フィールド型説明
JobIdDWORDファクス ドキュメントを受信したファクス ジョブを識別する一意の番号を指定します。
GuidGUID*ファクス ルーティング メソッドの GUID を格納する、null で終わる Unicode 文字列へのポインター。
FileEnumeratorPFAXROUTEENUMFILEファクス ルーティング拡張機能によって定義された FaxRouteEnumFile コールバック関数へのポインター。FaxRouteEnumFile は、受信したファクス ドキュメントに関連付けられたファクス ファイル リスト内のファイル名を受け取ります。
Contextvoid*FaxRouteEnumFiles が FaxRouteEnumFile 関数に渡す、拡張機能定義の値へのポインター。ファクス ルーティング メソッドがこの値を定義できます。

公式ドキュメント

ファクス ルーティング メソッドは、受信したファクス ドキュメントに関連付けられたファクス ファイル リスト内のファイルを列挙するために、FaxRouteEnumFiles コールバック関数を呼び出します。

FaxRoutingMethod は、FaxRouteEnumFiles を呼び出す場合、FaxRouteEnumFile コールバック関数へのポインターを渡します。

戻り値

Type: BOOL

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

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

解説(Remarks)

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

PFAXROUTEENUMFILES データ型は、FaxRouteEnumFiles 関数へのポインターを定義します。

ファクス ルーティング拡張機能 DLL は、FileEnumerator パラメーターで指定された FaxRouteEnumFile 関数を提供する必要があります。ファクス サービスは、ファクス ルーティング メソッドのファクス ファイル リスト内のファイルを列挙するために FaxRouteEnumFile を呼び出します。ファクス サービスは、ファクス ファイル リスト内のファイルごとに 1 回ずつ FaxRouteEnumFile を呼び出します。

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

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