Microsoft DirectX 8.1 (C++)

IDirectPlay8Address::GetUserData

Retrieves the user data in the address object. If no user data exists in this address object, this method returns DPNERR_DOESNOTEXIST.

HRESULT GetUserData(
void* pvUserData,
PDWORD pdwBufferSize
);

Parameters

pvUserData: [out] Pointer to a buffer to receive the user data from this address. To retrieve the required size, set this parameter to NULL and the DWORD in pdwBufferSize to 0.
pdwBufferSize: [in,out] Size in bytes of the buffer pointed to by pvUserData. If pvUserData is NULL, this parameter must point to a DWORD containing 0. On output, the contained DWORD is set to the number of bytes written to the buffer. On failure, this contains the number of bytes required to retrieve the user data and the method returns DPNERR_BUFFERTOOSMALL.

Return Values

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

DPNERR_DOESNOTEXIST

DPNERR_INVALIDPOINTER

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.