IUPnPRemoteEndpointInfo::GetDwordValue method (upnphost.h)

Article
02/22/2024

The GetDwordValue method gets a 4-byte value that provides information about either a request or requester.

Syntax

HRESULT GetDwordValue(
  [in]  BSTR  bstrValueName,
  [out] DWORD *pdwValue
);

Parameters

[in] bstrValueName

String that specifies the category of information to be retrieved.

[out] pdwValue

Pointer to a 4-byte value, the meaning of which depends on the value of bstrValueName.

If bstrValueName is "AddressFamily", the 4-byte value indicates the format of the requester's IP address as follows. The values are defined in Winsock2.h.

Value	Meaning
AF_INET	IP (IP version 4)
AF_INET6	IP6 (IP version 6)

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 value for the bstrValueName parameter is "AddressFamily". 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