IDirectPlay8Client::ReturnBuffer Method

Retrieves message buffers provided to the application through the pReceiveData member of the DPN_MSGID_RECEIVE system message. If the user's message handler returns DPNSUCCESS_PENDING to the RECEIVE callback, Microsoft® DirectPlay® assumes ownership of the buffer has been transferred to the application, and neither frees nor modifies it until ownership is returned to DirectPlay through this call.

Syntax

HRESULT ReturnBuffer(      
    const DPNHANDLE hBufferHandle,
    const DWORD dwFlags
);

Parameters

hBufferHandle

[in] Variable of type DPNHANDLE that specifies the buffer handle to the message. This is obtained in the hBufferHandle member of the DPN_MSGID_RECEIVE system message.

dwFlags

[in] Reserved. Must be 0.

Return Value

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

DPNERR_INVALIDHANDLE	The handle specified is invalid.
DPNERR_INVALIDPARAM	One or more of the parameters passed to the method are invalid.