Win32 API 日本語リファレンス
ホームNetworking.NetworkListManager › INetworkListManager

INetworkListManager

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IIDdcb00000-570f-4a9b-8d69-199fdba5723b継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

INetworkListManager インターフェイスは、ネットワーク一覧の管理機能を実行するための一連のメソッドを提供します。

メソッド 9

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

vtbl 7 HRESULT GetNetworks(NLM_ENUM_NETWORK Flags, IEnumNetworks** ppEnumNetwork)

GetNetworks メソッドは、ローカルマシンで利用可能なネットワークの一覧を取得します。

FlagsNLM_ENUM_NETWORKinネットワークのフラグ(具体的には、接続済みか未接続か)を指定する NLM_ENUM_NETWORK 列挙値。
ppEnumNetworkIEnumNetworks**out利用可能なネットワークの一覧の列挙子を含む IEnumNetworks インターフェイスインスタンスを受け取るポインターへのポインター。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は、次のいずれかの値を返します。

戻り値 説明
E_POINTER
渡されたポインターが NULL です。
E_UNEXPECTED
GUID が無効です。
vtbl 8 HRESULT GetNetwork(GUID gdNetworkId, INetwork** ppNetwork)

GetNetwork メソッドは、指定されたネットワーク ID に基づいてネットワークを取得します。

gdNetworkIdGUIDinネットワーク ID を指定する GUID。
ppNetworkINetwork**outこのネットワークの INetwork インターフェイスインスタンスを受け取るポインターへのポインター。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は、次のいずれかの値を返します。

戻り値 説明
E_POINTER
渡されたポインターが NULL です。
E_UNEXPECTED
GUID が無効です。
vtbl 9 HRESULT GetNetworkConnections(IEnumNetworkConnections** ppEnum)

GetNetworkConnections メソッドは、確立されたネットワーク接続の完全な一覧を列挙します。

ppEnumIEnumNetworkConnections**outマシン上のすべてのネットワーク接続を列挙する IEnumNetworkConnections インターフェイスインスタンスを受け取るポインターへのポインター。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は、次のいずれかの値を返します。

戻り値 説明
E_POINTER
渡されたポインターが NULL です。
vtbl 10 HRESULT GetNetworkConnection(GUID gdNetworkConnectionId, INetworkConnection** ppNetworkConnection)

GetNetworkConnection メソッドは、指定されたネットワーク接続 ID に基づいてネットワークを取得します。

gdNetworkConnectionIdGUIDinネットワーク接続 ID を指定する GUID
ppNetworkConnectionINetworkConnection**out指定された gdNetworkConnectionId に関連付けられた INetworkConnection オブジェクトへのポインターへのポインター。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は、次のいずれかの値を返します。

戻り値 説明
S_FALSE
指定されたネットワーク接続 ID に関連付けられたネットワークが見つかりませんでした。
E_POINTER
渡されたポインターが NULL です。
E_UNEXPECTED
指定された GUID が無効です。

解説(Remarks)

指定された ID に関連付けられたネットワーク接続が削除されている場合、このメソッドは S_FALSE を返すことがあります。 たとえば、クライアントがネットワーク接続 ID とともに INetworkConnectionEvents::NetworkConnectionConnectivityChanged イベントを受け取ったものの、指定された ID を使って INetworkListManager::GetNetworkConnection を呼び出す時点までに、そのネットワーク接続が切断されたり、置き換えられたりしている場合があります。

vtbl 11 HRESULT get_IsConnectedToInternet(VARIANT_BOOL* pbIsConnected)

get_IsConnectedToInternet プロパティは、ローカルマシンがインターネットに接続されているかどうかを示します。

pbIsConnectedVARIANT_BOOL*outTRUE の場合、ローカルマシンはインターネットに接続されています。FALSE の場合は接続されていません。

戻り値

成功した場合は S_OK を返します。

vtbl 12 HRESULT get_IsConnected(VARIANT_BOOL* pbIsConnected)

get_IsConnected プロパティは、ローカルマシンがネットワークに接続されているかどうかを示します。

pbIsConnectedVARIANT_BOOL*out

TRUE の場合、ネットワークは ipv4、ipv6、またはその両方を介した少なくともローカル接続を備えています。ネットワークはインターネット接続を備えている場合もあります。したがって、ネットワークは接続済みです。

FALSE の場合、ネットワークはローカル接続もインターネット接続も備えていません。ネットワークは接続されていません。

戻り値

成功した場合は S_OK を返します。

vtbl 13 HRESULT GetConnectivity(NLM_CONNECTIVITY* pConnectivity)

GetConnectivity メソッドは、マシン全体の接続状態を返します。

pConnectivityNLM_CONNECTIVITY*outこのマシンのネットワーク接続を指定するビットマスクを含む NLM_CONNECTIVITY 列挙値へのポインター。

戻り値

メソッドが成功した場合は S_OK を返します。

vtbl 14 HRESULT SetSimulatedProfileInfo(NLM_SIMULATED_PROFILE_INFO* pSimulatedInfo)

SetSimulatedProfileInfo メソッドは、特定の従量制インターネット接続の状態のシミュレーションをサポートするために、特定の接続プロファイル値のセットをインターネット接続プロファイルに適用します。

pSimulatedInfoNLM_SIMULATED_PROFILE_INFO*inRDP 子セッションから GetInternetConnectionProfile を呼び出す際に、現在のインターネット接続プロファイルでシミュレートする特定の接続プロファイル値。

戻り値

成功した場合は S_OK を返します。

vtbl 15 HRESULT ClearSimulatedProfileInfo()

SetSimulatedProfileInfo によってインターネット接続プロファイルに以前適用された接続プロファイル値をクリアします。次回の GetInternetConnectionProfile を介したインターネット接続クエリでは、システム情報が使用されます。

戻り値

成功した場合は S_OK を返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_INetworkListManager "{DCB00000-570F-4A9B-8D69-199FDBA5723B}"
#usecom global INetworkListManager IID_INetworkListManager "{DCB00C01-570F-4A9B-8D69-199FDBA5723B}"
#comfunc global INetworkListManager_GetNetworks                7 int,sptr
#comfunc global INetworkListManager_GetNetwork                 8 int,sptr
#comfunc global INetworkListManager_GetNetworkConnections      9 sptr
#comfunc global INetworkListManager_GetNetworkConnection       10 int,sptr
#comfunc global INetworkListManager_get_IsConnectedToInternet  11 var
#comfunc global INetworkListManager_get_IsConnected            12 var
#comfunc global INetworkListManager_GetConnectivity            13 var
#comfunc global INetworkListManager_SetSimulatedProfileInfo    14 var
#comfunc global INetworkListManager_ClearSimulatedProfileInfo  15
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。