Microsoft DirectX 9.0 SDK Update (Summer 2003) |
DPN_MSGID_SEND_COMPLETE Message
Microsoft® DirectPlay® generates the DPN_MSGID_SEND_COMPLETE message when an asynchronous send message request has completed.
The DPNMSG_SEND_COMPLETE structure contains information for the DPN_MSGID_SEND_COMPLETE system message.
Syntax
typedef struct _DPNMSG_SEND_COMPLETE { DWORD dwSize; DPNHANDLE hAsyncOp; PVOID pvUserContext; HRESULT hResultCode; DWORD dwSendTime; DWORD dwFirstFrameRTT; DWORD dwFirstRetryCount; DWORD dwSendCompleteFlags; const DPN_BUFFER_DESC pBuffers; DWORD dwNumBuffers; } DPNMSG_SEND_COMPLETE, *PDPNMSG_SEND_COMPLETE;
Members
- dwSize
- Size of this structure.
- hAsyncOp
- Asynchronous operation handle.
- pvUserContext
- User context supplied in the IDirectPlay8Client::Send, IDirectPlay8Peer::SendTo and IDirectPlay8Server::SendTo methods.
- hResultCode
- HRESULT indicating the result of the send message request.
- dwSendTime
- Total time, in milliseconds, between send call and completion.
- dwFirstFrameRTT
- The measured round-trip time for this message, if it is available. It will only be available for reliable messages that arrive on the first try and therefore do not need to be retransmitted. For all other messages this field is set to -1. For large messages that span multiple frames, this value will reflect the measured round-trip time for the first frame sent.
- dwFirstRetryCount
- For reliable messages, this gives the number of times DirectPlay had to retransmit the message before it was successfully delivered. For unreliable messages, this field is always set to -1.
- dwSendCompleteFlags
- Specify the following flags that describe how the message was sent.
- DPNSENDCOMPLETE_GUARANTEED
- The message was sent guaranteed.
- DPNSENDCOMPLETE_COALESCED
- The message was coalesced for sending.
- pBuffers
- Pointer to array of DPN_BUFFER_DESC structures sent.
- dwNumBuffers
- Number of DPN_BUFFER_DESC structures in the pBuffers array.
Remarks
Return from the message callback function with DPN_OK.
If the DPNSEND_NOCOPY flag was specified when IDirectPlay8Peer::SendTo, IDirectPlay8Client::Send, or IDirectPlay8Server::SendTo was called, the pBuffers and dwNumBuffers members refer to an array that contains the same buffer pointers and sizes that were passed when the send call was made. If the DPNSEND_NOCOPY flag was not specified, pBuffers is set to NULL and dwNumBuffers is set to 0.
Message Information
Header dplay8.h Minimum operating systems Windows 98, Pocket PC 2002