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

PFAXROUTEMODIFYROUTINGDATA

コールバック

シグネチャ

BOOL PFAXROUTEMODIFYROUTINGDATA(
    DWORD JobId,
    LPWSTR RoutingGuid,
    BYTE* RoutingData,
    DWORD RoutingDataSize
);

パラメーター

フィールド型説明
JobIdDWORDファクスドキュメントを受信したファクスジョブを識別する一意の番号を指定します。
RoutingGuidLPWSTR変更対象のファクスルーティングメソッドの GUID を指定する、NULL で終わる定数 Unicode 文字列へのポインターです。
RoutingDataBYTE*

ルーティング拡張によって定義された追加のルーティングデータを格納するバッファーへのポインターです。詳細については、後述の「解説」セクションを参照してください。

FaxRouteModifyRoutingData 関数を呼び出すファクスルーティングメソッドと、RoutingGuid パラメーターで指定されたルーティングメソッドは、RoutingData パラメーターのデータを解釈する必要があります。

RoutingDataSizeDWORDRoutingData パラメーターが指すバッファーのサイズ (バイト単位) を表す DWORD 変数を指定します。

公式ドキュメント

ファクスルーティングメソッドは、後続のファクスルーティングメソッドのルーティングデータを変更するために FaxRouteModifyRoutingData コールバック関数を呼び出します。

戻り値

型: BOOL

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

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

解説(Remarks)

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

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

ファクスルーティングメソッドは、後続のルーティングメソッドのルーティング情報を変更するために FaxRouteModifyRoutingData コールバック関数を呼び出すことができます。この関数は、後続のメソッドに適用される FAX_ROUTE 構造体の RoutingInfoData メンバーを変更することでこれを行います。これにより、ファクスルーティング拡張はユーザー定義のルーティングデータを取得し、別のルーティングメソッドに追加のコールバック情報を提供できます。後続のルーティングメソッドが実行されると、変更されたルーティングデータを使用して、受信したファクス送信を処理します。

RoutingGuid パラメーターで指定されたファクスルーティングメソッドは、呼び出し元のルーティングメソッドよりも優先度が低く、かつその後に実行される必要があります。優先度レベルは、ファクスドキュメントを受信したときにファクスサービスが各ファクスルーティングメソッドを呼び出す相対的な順序を決定します。

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