IUPnPRemoteEndpointInfo::GetStringValue method (upnphost.h)
The GetStringValue method gets a string that provides information about either a request or requester.
Syntax
HRESULT GetStringValue(
[in] BSTR bstrValueName,
[out] BSTR *pbstrValue
);
Parameters
[in] bstrValueName
String that specifies the category of information to be retrieved.
[out] pbstrValue
Pointer to a string, the meaning of which depends on the value of bstrValueName.
If bstrValueName is "RemoteAddress", the string is the requester's IP address.Windows 7: To retrieve the HTTP UserAgent header, set bstrValueName to "HttpUserAgent".
Return value
If the method succeeds, the return value is S_OK. Otherwise, the method returns one of the COM error codes defined in WinError.h.
Remarks
Currently, the only valid values for the bstrValueName parameter are "RemoteAddress" and (Windows 7 only) "HttpUserAgent". For any other value, this method will return the COM error code E_INVALIDARG.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista, Windows XP with SP2 [desktop apps only] |
| Minimum supported server | None supported |
| Target Platform | Windows |
| Header | upnphost.h |
| DLL | Upnphost.dll |