Win32 API 日本語リファレンス
ホームDevices.Enumeration.Pnp › IUPnPRemoteEndpointInfo

IUPnPRemoteEndpointInfo

COM
IIDc92eb863-0269-4aff-9c72-75321bba2952継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IUPnPRemoteEndpointInfo インターフェイスを使用すると、ホストされたデバイスが要求元 (すなわちコントロール ポイント) および要求に関する情報を取得できます。

メソッド 3

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

vtbl 3 HRESULT GetDwordValue(LPWSTR bstrValueName, DWORD* pdwValue)

GetDwordValue メソッドは、要求または要求元に関する情報を提供する 4 バイトの値を取得します。

bstrValueNameLPWSTRin取得する情報のカテゴリを指定する文字列です。
pdwValueDWORD*out

4 バイトの値へのポインターです。その意味は bstrValueName の値によって異なります。

bstrValueName が "AddressFamily" の場合、この 4 バイトの値は要求元の IP アドレスの形式を次のように示します。これらの値は Winsock2.h で定義されています。

意味
AF_INET
IP (IP バージョン 4)
AF_INET6
IP6 (IP バージョン 6)

戻り値

メソッドが成功した場合、戻り値は S_OK です。それ以外の場合、このメソッドは WinError.h で定義されている COM エラー コードのいずれかを返します。

解説(Remarks)

現在、bstrValueName パラメーターに指定できる有効な値は "AddressFamily" のみです。それ以外の値を指定した場合、このメソッドは COM エラー コード E_INVALIDARG を返します。

vtbl 4 HRESULT GetStringValue(LPWSTR bstrValueName, LPWSTR* pbstrValue)

GetStringValue メソッドは、要求または要求元に関する情報を提供する文字列を取得します。

bstrValueNameLPWSTRin取得する情報のカテゴリを指定する文字列です。
pbstrValueLPWSTR*out

文字列へのポインターです。その意味は bstrValueName の値によって異なります。

bstrValueName が "RemoteAddress" の場合、この文字列は要求元の IP アドレスです。Windows 7: HTTP UserAgent ヘッダーを取得するには、bstrValueName に "HttpUserAgent" を設定します。

戻り値

メソッドが成功した場合、戻り値は S_OK です。それ以外の場合、このメソッドは WinError.h で定義されている COM エラー コードのいずれかを返します。

解説(Remarks)

現在、bstrValueName パラメーターに指定できる有効な値は "RemoteAddress" および (Windows 7 のみ) "HttpUserAgent" のみです。それ以外の値を指定した場合、このメソッドは COM エラー コード E_INVALIDARG を返します。

vtbl 5 HRESULT GetGuidValue(LPWSTR bstrValueName, GUID* pguidValue)

GetGuidValue メソッドは現在サポートされていません。

bstrValueNameLPWSTRinサポートされていません。
pguidValueGUID*outサポートされていません。

戻り値

このメソッドは、WinError.h で定義されている COM エラー コードである E_INVALIDARG を返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUPnPRemoteEndpointInfo "{C92EB863-0269-4AFF-9C72-75321BBA2952}"
#usecom global IUPnPRemoteEndpointInfo IID_IUPnPRemoteEndpointInfo "{}"
#comfunc global IUPnPRemoteEndpointInfo_GetDwordValue   3 wstr,var
#comfunc global IUPnPRemoteEndpointInfo_GetStringValue  4 wstr,var
#comfunc global IUPnPRemoteEndpointInfo_GetGuidValue    5 wstr,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。