Platform SDK: DirectX

IDirectPlay4::CancelPriority

IDirectPlay4::CancelPriority メソッドは、まだ送信キューに入っている特定の、または特定範囲の優先順位のメッセージを、すべて取り消すときに使用する。CancelPriority は、非同期メッセージにのみ適用される。

メッセージ キューに残っているものの、一部が既に送信されているメッセージについては、取り消すことはできない。グループに送信されるメッセージで、そのグループの一部に既に送信されている場合は取り消すことができない。

メッセージを取り消しても、メッセージが取り消されたことを示す DPMSG_SENDCOMPLETE システム メッセージは生成される。

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

パラメータ

dwMinPriority
取り消す優先順位の範囲で、最も低い優先順位。
dwMaxPriority
取り消す優先順位の範囲で、最も高い優先順位。dwMinPriority よりも高くなければならない。可能な最高優先順位の MAXPRIORITY を設定する。
dwFlags
このパラメータは将来の使用に備えて予約されているので、0 に設定しておく。

戻り値

成功した場合は DP_OK を返す。失敗した場合は、次のエラー値のいずれかを返す。

DPERR_INVALIDFLAGS
DPERR_INVALIDPARAMS
DPERR_UNSUPPORTED

送信キューにメッセージがまったくない場合は、DP_OK を返す。

必要条件

  Windows NT/2000 : Windows 2000 が必要。
  Windows 95/98 : Windows 95 以降が必要。Windows 95 用に再配布可能な形で使用可能。
  ヘッダー : dplay.h で宣言。
  インポート ライブラリ : dplayx.lib を使用。

参照

IDirectPlay4::SendExIDirectPlay4::SendIDirectPlay4::GetMessageQueueDPMSG_SENDCOMPLETEIDirectPlay4::CancelMessage