ホーム › Networking.NetworkListManager › INetworkCostManager

INetworkCostManager

COM

📘 Microsoft Learn (日本語) · English

IIDdcb00008-570f-4a9b-8d69-199fdba5723b継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

このインターフェイスは、マシン全体のインターネット接続に使用される接続、または接続上の特定の宛先へのルーティングの最初のホップに関連付けられた、マシン全体のコストおよびデータプラン状態情報を照会するために使用します。

メソッド 3

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetCost(DWORD* pCost, NLM_SOCKADDR* pDestIPAddr)

GetCost メソッドは、マシン全体のインターネット接続、または接続上の特定の宛先へのルーティングの最初のホップの現在のコストを取得します。

pCost	DWORD*	out	接続のコストを示す DWORD 値です。下位 16 ビットはコストレベルを、上位 16 ビットはフラグを表します。指定可能な値は NLM_CONNECTION_COST 列挙型によって定義されます。
pDestIPAddr	NLM_SOCKADDR*	in	宛先の IPv4/IPv6 アドレスを含む NLM_SOCKADDR 構造体です。NULL の場合、このメソッドは代わりに、マシンのインターネット接続に使用される優先接続に関連付けられたコストを返します。

戻り値

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

戻り値コード	説明
E_POINTER	pCost が NULL です。
E_PENDING	宛先へのルーティングに使用するインターフェイスを現在判別中です。
E_INVALIDARG	destIPAddr で指定された宛先の IPv4/IPv6 アドレスが無効です。
HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED)	この要求はサポートされていません。このエラーは、ローカルコンピューターに IPv4 または IPv6 スタックが存在しないにもかかわらず、destIPAddr で IPv4 または IPv6 アドレスが指定された場合に返されます。
HRESULT_FROM_WIN32(ERROR_NO_NETWORK)	ネットワーク接続が現在利用できません。

vtbl 4 HRESULT GetDataPlanStatus(NLM_DATAPLAN_STATUS* pDataPlanStatus, NLM_SOCKADDR* pDestIPAddr)

GetDataPlanStatus は、マシン全体のインターネット接続、または接続上の特定の宛先へのルーティングの最初のホップのデータプラン状態を取得します。

pDataPlanStatus	NLM_DATAPLAN_STATUS*	out	宛先へのルーティングに使用される接続に関連付けられたデータプラン状態を記述する NLM_DATAPLAN_STATUS 構造体へのポインターです。destIPAddr がトンネルアドレスを指定している場合、インターフェイススタック内で最初に利用可能なデータプラン状態が返されます。
pDestIPAddr	NLM_SOCKADDR*	in	宛先の IPv4/IPv6 アドレスまたはトンネルアドレスを含む NLM_SOCKADDR 構造体です。NULL の場合、このメソッドは、マシンのインターネット接続に使用される優先接続に関連付けられたコストを返します。

戻り値

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

戻り値コード	説明
E_POINTER	pDataPlanStatus が NULL です。
E_PENDING	宛先へのルーティングに使用するインターフェイスを判別中です。
E_INVALIDARG	destIPAddr で指定された宛先アドレスが無効です。
HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED)	この要求はサポートされていません。このエラーは、ローカルコンピューターに IPv4 または IPv6 スタックが存在しないにもかかわらず、destIPAddr で IPv4 または IPv6 アドレスが指定された場合に返されます。
HRESULT_FROM_WIN32(ERROR_NO_NETWORK)	ネットワーク接続が現在利用できません。

vtbl 5 HRESULT SetDestinationAddresses(DWORD length, NLM_SOCKADDR* pDestIPAddrList, VARIANT_BOOL bAppend)

SetDestinationAddresses メソッドは、コストまたはデータプラン状態の変更通知を受け取るために、指定された宛先の IPv4/IPv6 アドレスを登録します。

length	DWORD	in	リスト内の宛先 IPv4/IPv6 アドレスの数です。
pDestIPAddrList	NLM_SOCKADDR*	in	コストまたはデータプラン状態の変更通知に登録する宛先 IPv4/IPv6 アドレスのリストを含む NLM_SOCKADDR 構造体です。
bAppend	VARIANT_BOOL	in	true の場合、pDestIPAddrList は既存のアドレスリストに追加されます。それ以外の場合、既存のリストは上書きされます。

戻り値

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

戻り値コード	説明
E_INVALIDARG	次のいずれかが発生した場合に返されます。 length が 0 です。 length が NLM_MAX_ADDRESS_LIST_SIZE(10) より大きいです。 bAppend が VARIANT_TRUE ですが、既存のリスト内の登録済み宛先の数と length の値を合わせると NLM_MAX_ADDRESS_SIZE を超えます。指定されたリスト内の宛先アドレスが無効です。
E_POINTER	destIPAddrList が NULL です。
HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED)	この要求はサポートされていません。このエラーは、ローカルコンピューターに IPv4 または IPv6 スタックが存在しないにもかかわらず、destIPAddr で IPv4 または IPv6 アドレスが指定された場合に返されます。
HRESULT_FROM_WIN32(ERROR_ALREADY_INITIALIZED)	このメソッドは、IConnectionPoint::Advise を呼び出して INetworkCostManagerEvents を登録した後に呼び出されました。詳細は「解説」を参照してください。

解説(Remarks)

このメソッドは IConnectionPoint::Advise の前に呼び出す必要があります。IConnectionPoint::Advise が呼び出されると、最後のシンクが IConnectionPoint::UnAdvise を呼び出すまで、このメソッドは正常に完了しません。ただし、IConnectionPoint::Advise の呼び出し前であれば、このメソッドを複数回呼び出すことができます。

pDestIPAddrList で示される宛先アドレスのリストに重複するアドレスが含まれている場合、コストの変更を通知するために各アドレスは 1 つのみ使用されます。呼び出し元は、length を 0、destIPAddrList を NULL、bAppend を FALSE に設定してこの関数を呼び出すことで、宛先のリストをクリアできます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_INetworkCostManager "{DCB00008-570F-4A9B-8D69-199FDBA5723B}"
#usecom global INetworkCostManager IID_INetworkCostManager "{}"
#comfunc global INetworkCostManager_GetCost                  3 var,var
#comfunc global INetworkCostManager_GetDataPlanStatus        4 var,var
#comfunc global INetworkCostManager_SetDestinationAddresses  5 int,var,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_INetworkCostManager "{DCB00008-570F-4A9B-8D69-199FDBA5723B}"
#usecom global INetworkCostManager IID_INetworkCostManager "{}"
#comfunc global INetworkCostManager_GetCost                  3 sptr,sptr
#comfunc global INetworkCostManager_GetDataPlanStatus        4 sptr,sptr
#comfunc global INetworkCostManager_SetDestinationAddresses  5 int,sptr,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。