ホーム › NetworkManagement.WindowsFirewall › IStaticPortMappingCollection

IStaticPortMappingCollection

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IIDcd1f3e77-66d6-4664-82c7-36dbb641d0f1継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

IStaticPortMappingCollection インターフェイスは、静的ポートマッピングのコレクションを管理するためのメソッドを提供します。

メソッド 5

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

vtbl 7 HRESULT get__NewEnum(IUnknown** pVal)

get__NewEnum メソッドは、静的ポートマッピングのコレクションの列挙子を取得します。

pVal

IUnknown**

out

コレクションの IUnknown インターフェイスへのポインターを受け取る、インターフェイスポインターへのポインターです。

戻り値

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

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

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

vtbl 8 HRESULT get_Item(INT lExternalPort, LPWSTR bstrProtocol, IStaticPortMapping** ppSPM)

get_Item メソッドは、指定されたポートマッピングをコレクションから取得します。

lExternalPort	INT	in	このポートマッピングの外部ポートを指定します。
bstrProtocol	LPWSTR	in	プロトコルを指定します。このパラメーターは UDP または TCP のいずれかである必要があります。
ppSPM	IStaticPortMapping**	out	このポートマッピングの IStaticPortMapping インターフェイスを指す、インターフェイスポインターへのポインターです。

戻り値

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

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

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

解説(Remarks)

UPnP テクノロジを使用する NAT API は、外部ポートとプロトコルの組み合わせによってポートマッピングを識別します。

vtbl 9 HRESULT get_Count(INT* pVal)

get_Count メソッドは、コレクション内のポートマッピングの数を取得します。

pVal

INT*

out

コレクション内のポートマッピングの数を受け取る long 型変数へのポインターです。

戻り値

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

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

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

vtbl 10 HRESULT Remove(INT lExternalPort, LPWSTR bstrProtocol)

Remove メソッドは、指定されたポートマッピングをコレクションから削除します。

lExternalPort	INT	in	このポートマッピングの外部ポートを指定します。
bstrProtocol	LPWSTR	in	プロトコルを指定します。このパラメーターは UDP または TCP のいずれかである必要があります。

戻り値

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

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

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

解説(Remarks)

UPnP テクノロジを使用する NAT API は、外部ポートとプロトコルの組み合わせによってポートマッピングを識別します。

vtbl 11 HRESULT Add(INT lExternalPort, LPWSTR bstrProtocol, INT lInternalPort, LPWSTR bstrInternalClient, VARIANT_BOOL bEnabled, LPWSTR bstrDescription, IStaticPortMapping** ppSPM)

Add メソッドは、新しいポートマッピングを作成してコレクションに追加します。

lExternalPort	INT	in	このポートマッピングの外部ポートを指定します。
bstrProtocol	LPWSTR	in	プロトコルを指定します。このパラメーターは UDP または TCP のいずれかである必要があります。
lInternalPort	INT	in	このポートマッピングの内部ポートを指定します。
bstrInternalClient	LPWSTR	in	このポートマッピングを使用する、プライベートネットワーク上のクライアントの名前を指定します。
bEnabled	VARIANT_BOOL	in	ポートが有効かどうかを指定します。
bstrDescription	LPWSTR	in	このポートマッピングの説明を指定します。
ppSPM	IStaticPortMapping**	out	呼び出しが成功したときに IStaticPortMapping インターフェイスへのポインターを受け取る、インターフェイスポインターへのポインターです。

戻り値

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

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

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

解説(Remarks)

UPnP テクノロジを使用する NAT API は、外部ポートとプロトコルの組み合わせによってポートマッピングを識別します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IStaticPortMappingCollection "{CD1F3E77-66D6-4664-82C7-36DBB641D0F1}"
#usecom global IStaticPortMappingCollection IID_IStaticPortMappingCollection "{}"
#comfunc global IStaticPortMappingCollection_get__NewEnum  7 sptr
#comfunc global IStaticPortMappingCollection_get_Item      8 int,wstr,sptr
#comfunc global IStaticPortMappingCollection_get_Count     9 var
#comfunc global IStaticPortMappingCollection_Remove        10 int,wstr
#comfunc global IStaticPortMappingCollection_Add           11 int,wstr,int,wstr,int,wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IStaticPortMappingCollection "{CD1F3E77-66D6-4664-82C7-36DBB641D0F1}"
#usecom global IStaticPortMappingCollection IID_IStaticPortMappingCollection "{}"
#comfunc global IStaticPortMappingCollection_get__NewEnum  7 sptr
#comfunc global IStaticPortMappingCollection_get_Item      8 int,wstr,sptr
#comfunc global IStaticPortMappingCollection_get_Count     9 sptr
#comfunc global IStaticPortMappingCollection_Remove        10 int,wstr
#comfunc global IStaticPortMappingCollection_Add           11 int,wstr,int,wstr,int,wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。