IDirectPlay8Server::CancelAsyncOperation メソッド
IDirectPlay8Server::CancelAsyncOperation メソッド
非同期の要求を取り消す。デフォルトでは、IDirectPlay8Server インターフェイスの多くのメソッドが非同期に実行される。状況に応じて、要求が処理される前にその要求を取り消したい場合もある。このインターフェイスで非同期に実行できるすべてのメソッドは、hAsyncHandle パラメータを返す。
要求の hAsyncHandle をこのメソッドの hAsyncHandle パラメータに渡すことによって、特定の要求が取り消される。このメソッドを呼び出し、hAsyncHandle パラメータに NULL を、dwFlags パラメータに DPNCANCEL_ALL_OPERATIONS を指定することによって、ペンディング状態のすべての非同期処理を取り消すことができる。特定のハンドルがこのメソッドに指定された場合は、いずれのフラグも設定してはならない。
構文
HRESULT CancelAsyncOperation(
const DPNHANDLE hAsyncHandle,
const DWORD dwFlags
);
パラメータ
- hAsyncHandle
[in] 停止する非同期処理のハンドル。すべての要求または特定の種類の非同期要求を停止するには、この値を NULL にする。特定のハンドルが指定されている場合、dwFlags パラメータは 0 に設定する。このハンドルは、非同期処理をサポートするメソッドを呼び出したときに受け取る。DPNCANCEL_PLAYER_SENDS フラグの 1 つが dwFlags パラメータに指定されている場合、hAsyncHandle はプレーヤの DPNID に設定する必要がある。 - dwFlags
[in] 取り消す非同期要求を指定するフラグ。次のいずれかのフラグを設定できる。DPNCANCEL_SEND
非同期 IDirectPlay8Server::SendTo 要求を取り消す。DPNCANCEL_PLAYER_SENDS
hAsyncHandle パラメータに指定されたプレーヤ用の非同期 IDirectPlay8Server::SendTo 要求をすべて取り消す。DPNCANCEL_PLAYER_SENDS_PRIORITY_LOW
hAsyncHandle パラメータに指定されたプレーヤ用の優先順位の低い非同期 IDirectPlay8Server::SendTo 要求を取り消す。DPNCANCEL_PLAYER_SENDS_PRIORITY_NORMAL
hAsyncHandle パラメータに指定されたプレーヤ用の、通常の優先順位の非同期 IDirectPlay8Server::SendTo 要求を取り消す。DPNCANCEL_PLAYER_SENDS_PRIORITY_HIGH
hAsyncHandle パラメータに指定されたプレーヤ用の優先順位の高い非同期 IDirectPlay8Server::SendTo 要求を取り消す。DPNCANCEL_ALL_OPERATIONS
すべての非同期要求を取り消す。
戻り値
成功した場合は S_OK を返し、失敗した場合は次のいずれかのエラー値を返す。
| DPNERR_CANNOTCANCEL | 処理を取り消すことができなかった。 |
| DPNERR_INVALIDFLAGS | このメソッドに渡されたフラグは無効である。 |
| DPNERR_INVALIDHANDLE | 指定されたハンドルは無効である。 |
| DPNSUCCESS_PENDING | 非同期処理で、キューへの設定が成功するところまで処理が進んだ。 |
注意
このメソッドを使って、IDirectPlay8Server::SendTo メソッドの非同期処理を取り消すことができる。Microsoft® DirectPlay® は、他の非同期処理の取り消しをサポートしていない。
IDirectPlay8Server::SendTo メソッドから返されたハンドルを指定すると、IDirectPlay8Server::SendTo 要求を取り消すことができる。その場合も、DPN_MSGID_SEND_COMPLETE システム メッセージは、DPNSEND_NOCOMPLETE フラグを設定せずに送信された非同期 IDirectPlay8Server::SendTo 要求ごとに、アプリケーション メッセージ ハンドラに送信される。このメソッドで取り消された送信要求は、DPN_MSGID_SEND_COMPLETE メッセージの hResultCode メンバに DPNERR_USERCANCEL を返す。
dwFlags に DPNCANCEL_ALL_OPERATIONS または DPNCANCEL_SEND フラグを設定した場合、DirectPlay はすべての一致する処理を取り消そうとする。このメソッドは、取り消しに失敗した処理がある場合、一部の取り消しが成功していてもエラーを返す。
次のいずれかの DPNCANCEL_PLAYER_SENDS フラグを dwFlags に設定した場合、hAsyncHandle にプレーヤの DPNID を指定する必要がある。この場合、dpnid パラメータに指定した DPNID が hAsyncHandle パラメータに設定した値と一致するペンディング状態の IDirectPlay8Server::SendTo 要求はすべて取り消される。
注 このメソッドが値を返すまで、完了メッセージは到着しない場合がある。DPN_MSGID_SEND_COMPLETE、DPN_MSGID_CONNECT_COMPLETE、または DPN_MSGID_ASYNC_OP_COMPLETE メッセージを受け取るまで、処理が終了したと見なしてはならない。