Edit

Share via

IWSDTransportAddress::GetTransportAddressEx method (wsdbase.h)

  • Article

Gets a pointer to a string representation of the address object. The format of the string varies, and is determined by the implementing interface (either IWSDHttpAddress or IWSDUdpAddress).

Syntax

HRESULT GetTransportAddressEx(
  [in]  BOOL    fSafe,
  [out] LPCWSTR *ppszAddress
);

Parameters

[in] fSafe

Specifies whether the scope identifier for an IPv6 address is included in the returned ppszAddress string. For example, if the address object represents an IPv6 link local address and fSafe is FALSE, then the IPv6 scope identifier will be included in the returned ppszAddress string.

If the address object represents an IPv4 address or a host name, this parameter is ignored.

[out] ppszAddress

String representation of the address object. Do not deallocate this pointer.

Return value

This method can return one of these values.

Possible return values include, but are not limited to, the following.

Return code Description
S_OK
 Method completed successfully.
E_POINTER
 ppszAddress is NULL.
S_FALSE
 The transport address has not yet been set. To set the transport address, call SetTransportAddress with a non-NULL address.

Remarks

The string returned by this method may contain an IPv4 or unbracketed IPv6 address such as "fe80::1". It may also contain a bracketed IPv6 address that includes the port such as "[fe80::1]:1234". The caller should parse the string carefully to account for both possibilities.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header wsdbase.h (include Wsdapi.h)
DLL Wsdapi.dll

See also

IWSDTransportAddress