ホーム › NetworkManagement.WindowsFirewall › INetConnection

INetConnection

COM

📘 Microsoft Learn (日本語) · English

IIDc08956a1-1cd3-11d1-b1c5-00805fc1270e継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

INetConnection インターフェイスは、ネットワーク接続を管理するためのメソッドを提供します。

メソッド 7

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

vtbl 3 HRESULT Connect()

Connect メソッドは、このネットワーク接続を接続 (確立) します。

戻り値

メソッドが成功した場合、戻り値は S_OK です。

メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。

戻り値	説明
E_ABORT	操作が中止されました。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	いずれかのパラメーターが無効です。
E_NOINTERFACE	指定されたインターフェイスはサポートされていません。
E_NOTIMPL	指定されたメソッドは実装されていません。
E_OUTOFMEMORY	メソッドは必要なメモリを割り当てられませんでした。
E_POINTER	パラメーターとして渡されたポインターが無効です。
E_UNEXPECTED	不明な理由によりメソッドが失敗しました。

vtbl 4 HRESULT Disconnect()

Disconnect メソッドは、この接続を切断します。

戻り値

メソッドが成功した場合、戻り値は S_OK です。

メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。

戻り値	説明
E_ABORT	操作が中止されました。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	いずれかのパラメーターが無効です。
E_NOINTERFACE	指定されたインターフェイスはサポートされていません。
E_NOTIMPL	指定されたメソッドは実装されていません。
E_OUTOFMEMORY	メソッドは必要なメモリを割り当てられませんでした。
E_POINTER	パラメーターとして渡されたポインターが無効です。
E_UNEXPECTED	不明な理由によりメソッドが失敗しました。

vtbl 5 HRESULT Delete()

Delete メソッドは、この接続を接続フォルダーから削除します。

戻り値

メソッドが成功した場合、戻り値は S_OK です。

メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。

戻り値	説明
E_ABORT	操作が中止されました。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	いずれかのパラメーターが無効です。
E_NOINTERFACE	指定されたインターフェイスはサポートされていません。
E_NOTIMPL	指定されたメソッドは実装されていません。
E_OUTOFMEMORY	メソッドは必要なメモリを割り当てられませんでした。
E_POINTER	パラメーターとして渡されたポインターが無効です。
E_UNEXPECTED	不明な理由によりメソッドが失敗しました。

vtbl 6 HRESULT Duplicate(LPWSTR pszwDuplicateName, INetConnection** ppCon)

Duplicate メソッドは、この接続の複製を接続フォルダー内に作成します。

pszwDuplicateName	LPWSTR	in	新しい接続の名前を指定する Unicode 文字列へのポインター。
ppCon	INetConnection**	out	インターフェイスポインターへのポインター。正常に返された場合、新しい接続の INetConnection インターフェイスを指します。

戻り値

メソッドが成功した場合、戻り値は S_OK です。

メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。

戻り値	説明
E_ABORT	操作が中止されました。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	いずれかのパラメーターが無効です。
E_NOINTERFACE	指定されたインターフェイスはサポートされていません。
E_NOTIMPL	指定されたメソッドは実装されていません。
E_OUTOFMEMORY	メソッドは必要なメモリを割り当てられませんでした。
E_POINTER	パラメーターとして渡されたポインターが無効です。
E_UNEXPECTED	不明な理由によりメソッドが失敗しました。

vtbl 7 HRESULT GetProperties(NETCON_PROPERTIES** ppProps)

GetProperties メソッドは、このネットワーク接続のプロパティを格納した構造体を取得します。

ppProps

NETCON_PROPERTIES**

out

ポインターへのポインター。正常に返された場合、このネットワーク接続のプロパティを格納した NETCON_PROPERTIES 構造体を指します。

戻り値

メソッドが成功した場合、戻り値は S_OK です。

メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。

戻り値	説明
E_ABORT	操作が中止されました。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	いずれかのパラメーターが無効です。
E_NOINTERFACE	指定されたインターフェイスはサポートされていません。
E_NOTIMPL	指定されたメソッドは実装されていません。
E_OUTOFMEMORY	メソッドは必要なメモリを割り当てられませんでした。
E_POINTER	パラメーターとして渡されたポインターが無効です。
E_UNEXPECTED	不明な理由によりメソッドが失敗しました。

解説(Remarks)

呼び出し側アプリケーションは、GetProperties が返す NETCON_PROPERTIES 構造体が占有するメモリを解放する必要があります。メモリの解放には NcFreeNetconProperties 関数を呼び出します。この関数は NetCon.h で定義され、NetShell.dll からエクスポートされます。

vtbl 8 HRESULT GetUiObjectClassId(GUID* pclsid)

GetUiObjectClassId メソッドは、この接続のユーザーインターフェイスオブジェクトのクラス識別子を取得します。

pclsid

GUID*

out

CLSID 変数へのポインター。正常に返された場合、この接続のユーザーインターフェイスオブジェクトのクラス識別子を指します。

戻り値

メソッドが成功した場合、戻り値は S_OK です。

メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。

戻り値	説明
E_ABORT	操作が中止されました。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	いずれかのパラメーターが無効です。
E_NOINTERFACE	指定されたインターフェイスはサポートされていません。
E_NOTIMPL	指定されたメソッドは実装されていません。
E_OUTOFMEMORY	メソッドは必要なメモリを割り当てられませんでした。
E_POINTER	パラメーターとして渡されたポインターが無効です。
E_UNEXPECTED	不明な理由によりメソッドが失敗しました。

vtbl 9 HRESULT Rename(LPWSTR pszwNewName)

Rename メソッドは、この接続の名前を変更します。

pszwNewName

LPWSTR

接続の新しい名前を格納する Unicode 文字列へのポインター。

戻り値

メソッドが成功した場合、戻り値は S_OK です。

メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。

戻り値	説明
E_ABORT	操作が中止されました。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	いずれかのパラメーターが無効です。
E_NOINTERFACE	指定されたインターフェイスはサポートされていません。
E_NOTIMPL	指定されたメソッドは実装されていません。
E_OUTOFMEMORY	メソッドは必要なメモリを割り当てられませんでした。
E_POINTER	パラメーターとして渡されたポインターが無効です。
E_UNEXPECTED	不明な理由によりメソッドが失敗しました。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_INetConnection "{C08956A1-1CD3-11D1-B1C5-00805FC1270E}"
#usecom global INetConnection IID_INetConnection "{}"
#comfunc global INetConnection_Connect             3
#comfunc global INetConnection_Disconnect          4
#comfunc global INetConnection_Delete              5
#comfunc global INetConnection_Duplicate           6 wstr,sptr
#comfunc global INetConnection_GetProperties       7 var
#comfunc global INetConnection_GetUiObjectClassId  8 var
#comfunc global INetConnection_Rename              9 wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_INetConnection "{C08956A1-1CD3-11D1-B1C5-00805FC1270E}"
#usecom global INetConnection IID_INetConnection "{}"
#comfunc global INetConnection_Connect             3
#comfunc global INetConnection_Disconnect          4
#comfunc global INetConnection_Delete              5
#comfunc global INetConnection_Duplicate           6 wstr,sptr
#comfunc global INetConnection_GetProperties       7 sptr
#comfunc global INetConnection_GetUiObjectClassId  8 sptr
#comfunc global INetConnection_Rename              9 wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。