Microsoft DirectX 8.0 (C++) |
非同期の要求を取り消す。デフォルトでは、IDirectPlay8Client インターフェイスの多くのメソッドが非同期に実行される。状況に応じて、要求が処理される前にその要求を取り消したい場合もある。このインターフェイスで非同期に実行できるすべてのメソッドは、hAsyncHandle パラメータを返す。
要求の hAsyncHandle をこのメソッドの hAsyncHandle パラメータに渡すことによって、特定の要求が取り消される。このメソッドを呼び出し、hAsyncHandle パラメータに NULL を、dwFlags パラメータに DPNCANCEL_ALL_OPERATIONS を指定することによって、待機中のすべての非同期処理を取り消すことができる。特定のハンドルがこのメソッドに指定された場合は、いずれのフラグも設定してはならない。
HRESULT CancelAsyncOperation( const DPNHANDLE hAsyncHandle, const DWORD dwFlags );
成功した場合は S_OK を返し、失敗した場合は次のいずれかのエラー値を返す。
DPNERR_CANNOTCANCEL |
DPNERR_INVALIDFLAGS |
DPNERR_INVALIDHANDLE |
DPNSUCCESS_PENDING |
このメソッドを使って、IDirectPlay8Client::Connect、IDirectPlay8Client::Send、および IDirectPlay8Client::EnumHosts メソッドの非同期処理を取り消すことができる。Microsoft® DirectPlay® 8.0 は、他の非同期処理の取り消しをサポートしていない。
IDirectPlay8Client::Send メソッドから返されたハンドルを指定すると、送信を取り消すことができる。その場合も、DPN_MSGID_SEND_COMPLETE システム メッセージは、DPNSEND_NOCOMPLETE フラグを設定せずに送信された非同期送信要求ごとに、アプリケーション メッセージ ハンドラに送信される。このメソッドで取り消された送信は、DPN_MSGID_SEND_COMPLETE メッセージの hResultCode メンバに DPNERR_USERCANCEL を返す。
dwFlags に DPNCANCEL_ALL_OPERATIONS、DPNCANCEL_CONNECT、DPNCANCEL_SEND、または DPNCANCEL_ENUM を設定した場合、DirectPlay はすべての一致する処理を取り消そうとする。このメソッドは、取り消しに失敗した処理がある場合、一部の取り消しが成功していてもエラーを返す。
注 このメソッドが戻るまで、完了メッセージが到着しない場合がある。DPN_MSGID_SEND_COMPLETE、DPN_MSGID_CONNECT_COMPLETE、または DPN_MSGID_ASYNC_OP_COMPLETE メッセージを受け取るまで、処理が終了したと見なしてはならない。
Windows NT/2000 : Windows 2000 以降に対する再配布可能ファイルとして提供。
Windows 95/98 : Windows 95 以降に対する再配布可能ファイルとして提供。
ヘッダー : Dplay8.h で宣言。