IUPnPAddressFamilyControl::GetAddressFamily method (upnp.h)

The GetAddressFamily method retrieves the current value of the address family flag of the Device Finder object.

Syntax

HRESULT GetAddressFamily(
  [out, retval] LONG *pdwFlags
);

Parameters

[out, retval] pdwFlags

Pointer to an integer (4-byte value) that indicates the address family.

The following values are valid.

Value	Meaning
UPNP_ADDRESSFAMILY_IPv4	IPv4 (IP version 4)
UPNP_ADDRESSFAMILY_IPv6	IPv6 (IP version 6)
UPNP_ADDRESSFAMILY_BOTH	IPv4 and IPv6

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.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	upnp.h
DLL	Upnp.dll

See also

IUPnPAddressFamilyControl

SetAddressFamily