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

IFaxInboundRoutingMethod

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID45700061-ad9d-4776-a8c4-64065492cf4b継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

IFaxInboundRoutingMethod インターフェイスは、接続先の FAX サーバー上にある個々の FAX 受信ルーティングメソッドに関する情報を、FAX クライアントアプリケーションが取得するために使用する構成オブジェクトを定義します。

解説(Remarks)

IFaxInboundRoutingMethod の既定の実装は FaxInboundRoutingMethod オブジェクトとして提供されます。

メソッド 9

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT get_Name(LPWSTR* pbstrName)

IFaxInboundRoutingMethod::get_Name プロパティは、FAX 受信ルーティングメソッドに関連付けられたわかりやすい名前を格納する、null で終わる文字列です。この文字列はユーザーへの表示に適しています。

pbstrNameLPWSTR*out受信ルーティングメソッドの名前を受け取るBSTRポインタ。
vtbl 8 HRESULT get_GUID(LPWSTR* pbstrGUID)

IFaxInboundRoutingMethod::get_GUID プロパティは、FAX ルーティングメソッドを一意に識別する GUID を指定する、null で終わる文字列です。

pbstrGUIDLPWSTR*outルーティングメソッドを一意に識別するGUID文字列を受け取るBSTRポインタ。
vtbl 9 HRESULT get_FunctionName(LPWSTR* pbstrFunctionName)

IFaxInboundRoutingMethod::get_FunctionName プロパティは、特定の FAX ルーティング処理を実行する関数の名前を格納する、null で終わる文字列です。

pbstrFunctionNameLPWSTR*outルーティング処理を実行する拡張DLL内の関数名を受け取るBSTRポインタ。

解説(Remarks)

この関数は、IFaxInboundRoutingMethod::get_ExtensionImageName プロパティで示される FAX ルーティング拡張 DLL が定義し、エクスポートします。

vtbl 10 HRESULT get_ExtensionFriendlyName(LPWSTR* pbstrExtensionFriendlyName)

IFaxInboundRoutingMethod::get_ExtensionFriendlyName プロパティは、FAX 受信ルーティングメソッドをエクスポートする FAX ルーティング拡張のわかりやすい名前です。

pbstrExtensionFriendlyNameLPWSTR*outこのメソッドを提供する拡張機能のフレンドリ名を受け取るBSTRポインタ。
vtbl 11 HRESULT get_ExtensionImageName(LPWSTR* pbstrExtensionImageName)

IFaxInboundRoutingMethod::get_ExtensionImageName プロパティは、FAX ルーティングメソッドをエクスポートする FAX ルーティング拡張の実行イメージ名 (DLL のパスとファイル名) を格納する、null で終わる文字列です。

pbstrExtensionImageNameLPWSTR*outこのメソッドを提供する拡張機能のイメージ(ファイル)名を受け取るBSTRポインタ。

解説(Remarks)

パスには、%SYSTEMDRIVE% や %SYSTEMROOT% などの有効な環境変数を含めることができます。

vtbl 12 HRESULT get_Priority(INT* plPriority)

Priority プロパティは、FAX サービスが FAX ジョブを受信したときにルーティングメソッドを呼び出す順序に関連付けられた値です。(Get)

plPriorityINT*outルーティングメソッドの適用優先順位を受け取るINTポインタ。値が小さいほど先に実行される。

解説(Remarks)

このプロパティの有効な値は 1 から n までで、1 が最も高い優先度です。

各ルーティングメソッドには一意の優先度の値を割り当ててください。IFaxInboundRoutingMethod::Save メソッドを呼び出すと、FAX サービスはルーティングメソッドを優先度順に並べ替えます。2 つのルーティングメソッドの優先度が同じ場合は、どちらの優先度を高くするかを FAX サービスが決定します。

特定のルーティングメソッドの優先度を可能な限り低くしたい場合は、999999 のような非常に大きな値を指定してから、IFaxInboundRoutingMethod::Save メソッドを呼び出してください。

このプロパティの読み取りまたは書き込みを行うには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 13 HRESULT put_Priority(INT lPriority)

Priority プロパティは、FAX サービスが FAX ジョブを受信したときにルーティングメソッドを呼び出す順序に関連付けられた値です。(Put)

lPriorityINTinルーティングメソッドの適用優先順位を設定するINT。値が小さいほど先に実行される。

解説(Remarks)

このプロパティの有効な値は 1 から n までで、1 が最も高い優先度です。

各ルーティングメソッドには一意の優先度の値を割り当ててください。IFaxInboundRoutingMethod::Save メソッドを呼び出すと、FAX サービスはルーティングメソッドを優先度順に並べ替えます。2 つのルーティングメソッドの優先度が同じ場合は、どちらの優先度を高くするかを FAX サービスが決定します。

特定のルーティングメソッドの優先度を可能な限り低くしたい場合は、999999 のような非常に大きな値を指定してから、IFaxInboundRoutingMethod::Save メソッドを呼び出してください。

このプロパティの読み取りまたは書き込みを行うには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 14 HRESULT Refresh()

IFaxInboundRoutingMethod::Refresh メソッドは、IFaxInboundRoutingMethod インターフェイスの情報を FAX サーバーから最新の状態に更新します。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

IFaxInboundRoutingMethod::Refresh メソッドを呼び出すと、最後に IFaxInboundRoutingMethod::Save メソッドを呼び出した後に行った構成の変更はすべて失われます。

このメソッドを使用するには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 15 HRESULT Save()

IFaxInboundRoutingMethod::Save メソッドは、IFaxInboundRoutingMethod インターフェイスのデータを保存します。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドを使用するには、ユーザーが farMANAGE_CONFIG および farQUERY_CONFIG アクセス権を持っている必要があります。

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

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IFaxInboundRoutingMethod "{45700061-AD9D-4776-A8C4-64065492CF4B}"
#usecom global IFaxInboundRoutingMethod IID_IFaxInboundRoutingMethod "{}"
#comfunc global IFaxInboundRoutingMethod_get_Name                   7 var
#comfunc global IFaxInboundRoutingMethod_get_GUID                   8 var
#comfunc global IFaxInboundRoutingMethod_get_FunctionName           9 var
#comfunc global IFaxInboundRoutingMethod_get_ExtensionFriendlyName  10 var
#comfunc global IFaxInboundRoutingMethod_get_ExtensionImageName     11 var
#comfunc global IFaxInboundRoutingMethod_get_Priority               12 var
#comfunc global IFaxInboundRoutingMethod_put_Priority               13 int
#comfunc global IFaxInboundRoutingMethod_Refresh                    14
#comfunc global IFaxInboundRoutingMethod_Save                       15
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。