IDirectPlay8Address::GetUserData Method

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

Syntax

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 pdwBufferSizeto 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 Value

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

DPNERR_DOESNOTEXIST	Requested element is not part of the address.
DPNERR_INVALIDPOINTER	Pointer specified as a parameter is invalid.
DPNERR_BUFFERTOOSMALL	The supplied buffer is not large enough to contain the requested data.