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

IFaxOutboundRoutingRules

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

公式ドキュメント

IFaxOutboundRoutingRules インターフェースは、FAX クライアント アプリケーションが FAX の送信ルーティング ルールを管理するために使用する構成コレクションを表します。

解説(Remarks)

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

メソッド 7

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

vtbl 7 HRESULT get__NewEnum(IUnknown** ppUnk)

IFaxOutboundRoutingRules::get__NewEnum メソッドは、FaxOutboundRoutingRules コレクションを反復処理するために使用できる列挙子オブジェクトへの参照を返します。

ppUnkIUnknown**out このコレクションの列挙子オブジェクトの IUnknown インターフェースへの間接ポインターを受け取ります。

戻り値

型: HRESULT

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

vtbl 8 HRESULT get_Item(INT lIndex, IFaxOutboundRoutingRule** pFaxOutboundRoutingRule)

IFaxOutboundRoutingRules::get_Item メソッドは、ルーティング ルールのインデックスを使用して、IFaxOutboundRoutingRules インターフェースから IFaxOutboundRoutingRule インターフェースを返します。

lIndexINTinコレクションから取得する送信ルーティング ルールを指定する long 値です。このパラメーターの有効な値は 1 から n までの範囲で、n は IFaxOutboundRoutingRules::get_Count メソッドの呼び出しによって返される項目数です。
pFaxOutboundRoutingRuleIFaxOutboundRoutingRule**outIFaxOutboundRoutingRule インターフェースを受け取るポインターのアドレスです。

戻り値

型: HRESULT

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

vtbl 9 HRESULT get_Count(INT* plCount)

IFaxOutboundRoutingRules::get_Count プロパティは、FaxOutboundRoutingRules コレクション内のオブジェクトの数を表します。これは、FAX サーバーに関連付けられている送信ルーティング ルールの総数です。

plCountINT*out送信ルーティングルールの数を受け取るINTポインタ。
vtbl 10 HRESULT ItemByCountryAndArea(INT lCountryCode, INT lAreaCode, IFaxOutboundRoutingRule** pFaxOutboundRoutingRule)

IFaxOutboundRoutingRules::get_ItemByCountryAndArea メソッドは、ルーティング ルールの国/地域コードと市外局番を使用して、コレクションから送信ルーティング ルール (FaxOutboundRoutingRule オブジェクト) を返します。

lCountryCodeINTin取得する送信ルーティング ルールの国/地域コードを指定する long 値です。frrcANY_CODE を指定すると、任意の国/地域コードに対するルールが返されます。
lAreaCodeINTin取得する送信ルーティング ルールの市外局番を指定する long 値です。frrcANY_CODE を指定すると、指定した国/地域コード内の任意の市外局番に対するルールが返されます。
pFaxOutboundRoutingRuleIFaxOutboundRoutingRule**outFaxOutboundRoutingRule オブジェクトです。

戻り値

型: HRESULT

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

vtbl 11 HRESULT RemoveByCountryAndArea(INT lCountryCode, INT lAreaCode)

IFaxOutboundRoutingRules::RemoveByCountryAndArea メソッドは、ルーティング ルールの国/地域コードと市外局番を使用して、コレクションから送信ルーティング ルール (FaxOutboundRoutingRule オブジェクト) を削除します。

lCountryCodeINTinコレクションから削除する送信ルーティング ルールの国/地域コードを指定する long 値です。frrcANY_CODE を指定すると、すべての国/地域コードに適用されるルールが削除されます。
lAreaCodeINTinコレクションから削除する送信ルーティング ルールの市外局番を指定する long 値です。frrcANY_CODE を指定すると、指定した国/地域コード内のすべての市外局番に適用されるルールが削除されます。

戻り値

型: HRESULT

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

解説(Remarks)

lCountryCode と lAreaCode の両方を frrcANY_CODE に設定することはできません。これは既定の送信ルーティング ルールを指定することと同等であり、そのルールは削除できないためです。

vtbl 12 HRESULT Remove(INT lIndex)

IFaxOutboundRoutingRules::Remove メソッドは、ルーティング ルールのインデックスを使用して、FaxOutboundRoutingRules コレクションから送信ルーティング ルール (FaxOutboundRoutingRule オブジェクト) を削除します。

lIndexINTinコレクションから削除する送信ルーティング ルールのインデックスを指定する long 値です。このパラメーターの有効な値は 1 から n までの範囲で、n は IFaxOutboundRoutingRules::get_Count メソッドの呼び出しによって返されるルールの数です。

戻り値

型: HRESULT

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

解説(Remarks)

既定の送信ルーティング ルールは削除できません。

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

vtbl 13 HRESULT Add(INT lCountryCode, INT lAreaCode, VARIANT_BOOL bUseDevice, LPWSTR bstrGroupName, INT lDeviceId, IFaxOutboundRoutingRule** pFaxOutboundRoutingRule)

IFaxOutboundRoutingRules::Add メソッドは、IFaxOutboundRoutingRules インターフェースで定義されるコレクションに、送信ルーティング ルール (IFaxOutboundRoutingRule インターフェース) を追加します。

lCountryCodeINTin送信ルーティング ルールに関連付ける国/地域コードを指定する long 値です。frrcANY_CODE を指定すると、任意の国/地域コードに適用されるルールが追加されます。
lAreaCodeINTin送信ルーティング ルールに関連付ける市外局番を示す long 値を指定します。frrcANY_CODE を指定すると、指定した国/地域コード内の任意の市外局番に適用されるルールが追加されます。
bUseDeviceVARIANT_BOOLin送信ルーティング ルールがデバイスのグループではなく単一の FAX デバイスを指すかどうかを示すブール値を指定します。
bstrGroupNameLPWSTRin新しいルーティング ルールが属する送信ルーティング グループの名前を格納する、null で終わる文字列を指定します。bUseDevice が TRUE に設定されている場合は、空の文字列を指定します。
lDeviceIdINTin送信ルーティング ルールに関連付けるデバイスを指定します。bUseDevice が FALSE に設定されている場合、このパラメーターは無視されます。
pFaxOutboundRoutingRuleIFaxOutboundRoutingRule**outIFaxOutboundRoutingRule インターフェースを受け取るポインターのアドレスです。

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドは、リモート プロシージャ コール (RPC) の戻り値を返す場合もあります。詳細については、「RPC Return Values」を参照してください。

このプロパティの読み取りまたは書き込みを行うには、ユーザーが farMANAGE_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_IFaxOutboundRoutingRules "{DCEFA1E7-AE7D-4ED6-8521-369EDCCA5120}"
#usecom global IFaxOutboundRoutingRules IID_IFaxOutboundRoutingRules "{}"
#comfunc global IFaxOutboundRoutingRules_get__NewEnum            7 sptr
#comfunc global IFaxOutboundRoutingRules_get_Item                8 int,sptr
#comfunc global IFaxOutboundRoutingRules_get_Count               9 var
#comfunc global IFaxOutboundRoutingRules_ItemByCountryAndArea    10 int,int,sptr
#comfunc global IFaxOutboundRoutingRules_RemoveByCountryAndArea  11 int,int
#comfunc global IFaxOutboundRoutingRules_Remove                  12 int
#comfunc global IFaxOutboundRoutingRules_Add                     13 int,int,int,wstr,int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。