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

IFaxOutboundRoutingGroups

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

公式ドキュメント

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

解説(Remarks)

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

メソッド 5

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

vtbl 7 HRESULT get__NewEnum(IUnknown** ppUnk)

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

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

戻り値

型: HRESULT

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

vtbl 8 HRESULT get_Item(VARIANT vIndex, IFaxOutboundRoutingGroup** pFaxOutboundRoutingGroup)

IFaxOutboundRoutingGroups::get_Item メソッドは、コレクションから IFaxOutboundRoutingGroup インターフェイスを返します。

vIndexVARIANTin

コレクションから取得する項目を指定する Variant です。

このパラメーターの型が VT_I2 または VT_I4 の場合、コレクションから取得する項目のインデックスを指定します。インデックスは 1 から始まります。このパラメーターの型が VT_BSTR の場合、取得する送信ルーティング グループを識別する一意の名前になります。その他の型はサポートされていません。

pFaxOutboundRoutingGroupIFaxOutboundRoutingGroup**outIFaxOutboundRoutingGroup インターフェイスを受け取るポインターのアドレスです。

戻り値

型: HRESULT

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

解説(Remarks)

すべてのデバイスで構成されるグループを返すには、vIndex に定数 bstrGROUPNAME_ALLDEVICES を設定します。

vtbl 9 HRESULT get_Count(INT* plCount)

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

plCountINT*out送信ルーティンググループの数を受け取るINTポインタ。
vtbl 10 HRESULT Add(LPWSTR bstrName, IFaxOutboundRoutingGroup** pFaxOutboundRoutingGroup)

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

bstrNameLPWSTRin追加するグループの名前を示す null 終端文字列です。特別なルーティング グループである All Devices は追加できないことに注意してください。
pFaxOutboundRoutingGroupIFaxOutboundRoutingGroup**outIFaxOutboundRoutingGroup インターフェイスを受け取るポインターのアドレスです。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 11 HRESULT Remove(VARIANT vIndex)

Remove メソッドは、FaxOutboundRoutingGroups コレクションから項目を削除します。

vIndexVARIANTin

コレクションから削除する項目を指定する Variant です。

このパラメーターの型が VT_I2 または VT_I4 の場合、コレクションから削除する項目のインデックスを指定します。このパラメーターの有効な値は 1 から n までの範囲で、n は IFaxOutboundRoutingGroups::get_Count メソッドの呼び出しによって返されるオブジェクトの数です。インデックスは 1 から始まります。このパラメーターの型が VT_BSTR の場合、削除する送信ルーティング グループを識別する一意の名前になります。その他の型はサポートされていません。

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドを使用するには、ユーザーが 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_IFaxOutboundRoutingGroups "{235CBEF7-C2DE-4BFD-B8DA-75097C82C87F}"
#usecom global IFaxOutboundRoutingGroups IID_IFaxOutboundRoutingGroups "{}"
#comfunc global IFaxOutboundRoutingGroups_get__NewEnum  7 sptr
#comfunc global IFaxOutboundRoutingGroups_get_Item      8 int,sptr
#comfunc global IFaxOutboundRoutingGroups_get_Count     9 var
#comfunc global IFaxOutboundRoutingGroups_Add           10 wstr,sptr
#comfunc global IFaxOutboundRoutingGroups_Remove        11 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。