WebSocketAbortHandle 関数 (websocket.h)
WebSocketAbortHandle 関数は、WebSocketCreateClientHandle または WebSocketCreateServerHandle によって作成された WebSocket セッション ハンドルを中止します。
構文
void WebSocketAbortHandle(
[in] WEB_SOCKET_HANDLE hWebSocket
);
パラメーター
[in] hWebSocket
WebSocketCreateClientHandle または WebSocketCreateServerHandle の以前の呼び出しによって返された WebSocket セッション ハンドル。
戻り値
関数が成功した場合は、S_OK を返します。
関数が失敗した場合は、WinError.h で定義された システム エラー コード を返します。
注釈
WebSocketAbortHandle は WEB_SOCKET_HANDLE セッション ハンドルを中止し、中止されたハンドルを使用して呼び出されると 、WebSocketSend または WebSocketReceive への 呼び出しでエラーが返されます。 WebSocketAbortHandle は、WebSocket ハンドシェイクが完了せず、セッション ハンドルが初期化されていない場合、no-op です。 WebSocketSend または WebSocketReceive を使用してキューに入れられていた送受信操作は、WebSocketGetAction を使用して処理する準備が整いますが、中止されたハンドルを使用して追加の操作をキューに登録しようとすると、エラーが発生します。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 8 [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2012 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | websocket.h |
| Library | Websocket.lib |
| [DLL] | Websocket.dll |