IDirectPlay8Address::SetUserData Method

DirectPlay

previous page next page
 
Microsoft DirectX 9.0 SDK Update (Summer 2003)

IDirectPlay8Address::SetUserData Method

Sets the user data in the address object. If there is user data in this address, it is overwritten by this call.

Syntax

HRESULT SetUserData(      
    const void *const pvUserData,
    const DWORD dwDataSize
);

Parameters

pvUserData
[in] Pointer to a buffer that contains the data to place in the user data section of the address. Set to NULL to clear the user data.
dwDataSize
[in] Size, in bytes, of the data in pvUserData. If pvUserData is NULL, this must be 0.

Return Value

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

DPNERR_INVALIDPOINTERPointer specified as a parameter is invalid.
DPNERR_NOTALLOWEDThis function is not allowed on this object.


© 2003 Microsoft Corporation. All rights reserved.
previous page start next page