IDirectPlay8Peer::GetSendQueueInfo Method

Used by the application to monitor the size of the send queue.

Syntax

HRESULT GetSendQueueInfo(      

    const DPNID dpnid,
    DWORD *const pdwNumMsgs,
    DWORD *const pdwNumBytes,
    const DWORD dwFlags
);

Parameters

dpnid

[in] DPNID of the player to get send queue information for.

pdwNumMsgs

[out] Pointer to a variable of type DWORD that contains the number of messages currently queued. This value is optional, and can be set to NULL.

pdwNumBytes

[out] Pointer to a variable of type DWORD that specifies the total number of bytes of data of the messages currently queued. This value is optional, and can be set to NULL.

dwFlags

[in] You can specify the DPNGETSENDQUEUEINFO_PRIORITY_NORMAL, DPNGETSENDQUEUEINFO_PRIORITY_HIGH, or DPNGETSENDQUEUEINFO_PRIORITY_LOW flag to inquire about specific messages of that priority.

Return Value

Returns S_OK if successful, or the following error value.

DPNERR_INVALIDPARAM

One or more of the parameters passed to the method are invalid.

Remarks

Microsoft?DirectPlay?will not send messages faster than the receiving computer can process them. As a result, if the sending computer is sending faster than the receiver can receive, messages accumulate in the sender's queue. If the application registers that the send queue is growing too large, it should slow the rate that messages are sent.

You cannot set both pdwNumMsgs and pdwNumBytes to NULL. At least one of them must be set to a valid pointer.