Win32 API 日本語リファレンス
ホームNetworkManagement.WindowsFirewall › IUPnPNAT

IUPnPNAT

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IIDb171c812-cc76-485a-94d8-b6b3a2794e99継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

IUPnPNAT インターフェイスは、UPnP を使用してネットワークアドレス変換 (NAT) を管理するための主要なインターフェイスです。IUPnPNAT インターフェイスは、UPnP テクノロジを使用する NAT API の他のすべてのインターフェイスへ、直接または間接的にアクセスする手段を提供します。

メソッド 3

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

vtbl 7 HRESULT get_StaticPortMappingCollection(IStaticPortMappingCollection** ppSPMs)

get_StaticPortMappingCollection メソッドは、ローカルコンピューターが使用する NAT 上の静的ポートマッピングのコレクションを表すインターフェイスを取得します。

ppSPMsIStaticPortMappingCollection**outIStaticPortMappingCollection インターフェイスを指すインターフェイスポインターへのポインター。

戻り値

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

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

戻り値 説明
E_ABORT
操作が中止されました。
E_FAIL
原因不明のエラーが発生しました。
E_INVALIDARG
いずれかのパラメーターが無効です。
E_NOINTERFACE
指定されたインターフェイスはサポートされていません。
E_NOTIMPL
指定されたメソッドは実装されていません。
E_OUTOFMEMORY
メソッドが必要なメモリを割り当てられませんでした。
E_POINTER
パラメーターとして渡されたポインターが無効です。
E_UNEXPECTED
不明な理由によりメソッドが失敗しました。
vtbl 8 HRESULT get_DynamicPortMappingCollection(IDynamicPortMappingCollection** ppDPMs)
ppDPMsIDynamicPortMappingCollection**out動的ポートマッピングのコレクションを表す IDynamicPortMappingCollection インターフェイスを受け取るポインタへのポインタである。
vtbl 9 HRESULT get_NATEventManager(INATEventManager** ppNEM)

get_NATEventManager メソッドは、ローカルコンピューターが使用する NAT に対する INATEventManager インターフェイスを取得します。

ppNEMINATEventManager**outINATEventManager インターフェイスを指すインターフェイスポインターへのポインター。

戻り値

メソッドが成功した場合、戻り値は 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_IUPnPNAT "{B171C812-CC76-485A-94D8-B6B3A2794E99}"
#usecom global IUPnPNAT IID_IUPnPNAT "{AE1E00AA-3FD5-403C-8A27-2BBDC30CD0E1}"
#comfunc global IUPnPNAT_get_StaticPortMappingCollection   7 sptr
#comfunc global IUPnPNAT_get_DynamicPortMappingCollection  8 sptr
#comfunc global IUPnPNAT_get_NATEventManager               9 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。