Microsoft DirectX 8.1 (C++)

IDirectPlay8Address::GetURLA

Retrieves the Microsoft® DirectPlay® address URL string represented by this object. (ANSI Version.)

HRESULT GetURLA(
CHAR* pszURL,
PDWORD pdwNumChars
);

Parameters

pszURL
[out] Address of a pointer to receive the URL represented by this object. This parameter can be NULL if pdwNumChars points to a DWORD containing 0.
pdwNumChars
[in,out] Pointer to a DWORD that contains the number of characters the specified buffer can hold, including NULL terminator. On success this value contains the number of characters written to the specified buffer, including NULL terminator. On failure this value contains the number of characters, including NULL terminator, required to hold the URL and the method returns DPNERR_BUFFERTOOSMALL.

Return Values

Returns S_OK if successful, or one of the following error values.

DPNERR_BUFFERTOOSMALL
DPNERR_GENERIC
DPNERR_INVALIDURL
DPNERR_OUTOFMEMORY

Requirements

  Windows NT/2000/XP: Available as a redistributable for Windows 2000 and later.
  Windows 98/Me: Available as a redistributable for Windows 98 and later.
  Header: Declared in Dpaddr.h.