IDirectPlay8Address::GetURLA Method

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

Syntax

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 the terminating NULL character. On success this value contains the number of characters written to the specified buffer, including the terminating NULL character. On failure this value contains the number of characters, including the terminating NULL character, required to hold the URL and the method returns DPNERR_BUFFERTOOSMALL.

Return Value

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

DPNERR_BUFFERTOOSMALL	The supplied buffer is not large enough to contain the requested data.
DPNERR_GENERIC	An undefined error condition occurred.
DPNERR_INVALIDURL	Specified string is not a valid DirectPlayURL.
DPNERR_OUTOFMEMORY	There is insufficient memory to perform the requested operation.