Edit

Share via

IWSDAddress::Serialize method (wsdbase.h)

  • Article

Assembles the component parts of the address into a string.

Syntax

HRESULT Serialize(
  [out] LPWSTR pszBuffer,
  [in]  DWORD  cchLength,
  [in]  BOOL   fSafe
);

Parameters

[out] pszBuffer

Buffer to receive the assembled address.

[in] cchLength

Length of pszBuffer, in bytes.

[in] fSafe

If TRUE, the resulting string will be network safe. For example, if you used IWSDTransportAddress to build an IPv6 address, the serialized string will not contain the IPv6 scope identifier. However, if fSafe is FALSE, then the resulting string will contain the IPv6 scope identifier. For all other IWSDAddress derived objects, there is no specific meaning for this parameter (other than ensuring that the method generate portable addresses).

Return value

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

Return code Description
S_OK
 Method completed successfully.
E_POINTER
 pszBuffer is NULL.
E_ABORT
 The method could not be completed.

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

IWSDAddress