IDirectPlay4::CancelPriority

IDirectPlay4 Interface

Used to cancel all messages of a particular priority or range of priorities that are still in the send queue. CancelPriority applies only to asynchronous messages.

Messages that have left the message queue and are partially sent cannot be canceled. A message sent to a group cannot be canceled once it has been sent to at least one member of the group.

Canceling a message still generates a DPMSG_SENDCOMPLETE system message indicating the message was canceled.

Syntax

HRESULT CancelPriority(
  DWORD dwMinPriority,
  DWORD dwMaxPriority,
  DWORD dwFlags
  );

Parameters

dwMinPriority
The minimum priority in the range to be canceled.
dwMaxPriority
The maximum priority in the range to be canceled. Must be greater than dwMinPriority. Set to MAXPRIORITY for the maximum possible priority.
dwFlags
This parameter is reserved. Must be zero.

Return Value

Returns DP_OK if successful, or one of the following error values otherwise:
DPERR_INVALIDFLAGS
DPERR_INVALIDPARAMS
DPERR_UNSUPPORTED

This method returns DP_OK if there are no messages in the send queue.

See Also

IDirectPlay4::SendEx, IDirectPlay4::Send, IDirectPlay4::GetMessageQueue, DPMSG_SENDCOMPLETE, IDirectPlay4::CancelMessage

Top of Page Top of Page
© 1998 Microsoft Corporation. All rights reserved. Terms of Use.