ホーム › NetworkManagement.WindowsFirewall › INATEventManager

INATEventManager

COMIDispatch (デュアル)

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

IID624bd588-9060-4109-b0b0-1adbbcac32df継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

INATEventManager インターフェイスは、UPnP テクノロジを利用する NAT アプリケーションがコールバックインターフェイスを NAT に登録するためのメソッドを提供します。NAT の構成が変更されると、システムはこれらのインターフェイスのメソッドを呼び出します。

メソッド 2

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

vtbl 7 HRESULT put_ExternalIPAddressCallback(IUnknown* pUnk)

put_ExternalIPAddressCallback メソッドを使用すると、UPnP テクノロジを利用する NAT アプリケーションがコールバックインターフェイスを NAT に登録できます。NAT の外部 IP アドレスが変更されると、システムはこのコールバックインターフェイスの最初のメソッドを呼び出します。

pUnk

IUnknown*

IUnknown インターフェイスまたは IDispatch インターフェイスのいずれかをサポートするオブジェクトへのポインターです。詳細については「解説」セクションを参照してください。

戻り値

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

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

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

解説(Remarks)

pUnk が参照するオブジェクトは、 INATExternalIPAddressCallback インターフェイスまたは IDispatch インターフェイスのいずれかをサポートしている必要があります。NAT はまず pUnk に対して INATExternalIPAddressCallback インターフェイスをクエリします。このインターフェイスがサポートされていない場合、NAT は pUnk に対して IDispatch インターフェイスをクエリします。IDispatch インターフェイスもサポートされていない場合、put_ExternalIPAddressCallback メソッドは E_FAIL を返します。

IDispatch のみがサポートされている場合、NAT はディスパッチ ID にゼロ (既定のメソッドを示します) を指定して IDispatch::Invoke を呼び出すことでコールバックを呼び出します。この IDispatch メソッドには、 INATExternalIPAddressCallback メソッドと同じパラメーターが渡されますが、最初に渡されるパラメーターはコールバックが呼び出された理由を示す文字列である点が異なります。

vtbl 8 HRESULT put_NumberOfEntriesCallback(IUnknown* pUnk)

put_NumberOfEntriesCallback メソッドを使用すると、UPnP テクノロジを利用する NAT アプリケーションがコールバックインターフェイスを NAT に登録できます。NAT のポートマッピングの数が変更されると、システムはこのコールバックインターフェイスの最初のメソッドを呼び出します。

pUnk

IUnknown*

戻り値

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

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

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

解説(Remarks)

pUnk が参照するオブジェクトは、 INATNumberOfEntriesCallback インターフェイスまたは IDispatch インターフェイスのいずれかをサポートしている必要があります。NAT はまず pUnk に対して INATNumberOfEntriesCallback インターフェイスをクエリします。このインターフェイスがサポートされていない場合、NAT は pUnk に対して IDispatch インターフェイスをクエリします。IDispatch インターフェイスもサポートされていない場合、NumberOfEntriesCallback メソッドは E_FAIL を返します。

IDispatch のみがサポートされている場合、NAT はディスパッチ ID にゼロ (既定のメソッドを示します) を指定して IDispatch::Invoke を呼び出すことでコールバックを呼び出します。この IDispatch メソッドには、 INATNumberOfEntriesCallback メソッドと同じパラメーターが渡されますが、最初に渡されるパラメーターはコールバックが呼び出された理由を示す文字列である点が異なります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_INATEventManager "{624BD588-9060-4109-B0B0-1ADBBCAC32DF}"
#usecom global INATEventManager IID_INATEventManager "{}"
#comfunc global INATEventManager_put_ExternalIPAddressCallback  7 sptr
#comfunc global INATEventManager_put_NumberOfEntriesCallback    8 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。