Функция WinHttpWebSocketClose (winhttp.h)
Функция WinHttpWebSocketClose закрывает подключение WebSocket.
Синтаксис
WINHTTPAPI DWORD WinHttpWebSocketClose(
[in] HINTERNET hWebSocket,
[in] USHORT usStatus,
[in, optional] PVOID pvReason,
[in] DWORD dwReasonLength
);
Параметры
[in] hWebSocket
Тип: HINTERNET
Обработка в WebSocket.
[in] usStatus
Тип: USHORT
Код состояния закрытия. Возможные значения см. в WINHTTP_WEB_SOCKET_CLOSE_STATUS .
[in, optional] pvReason
Тип: PVOID
Подробная причина закрытия.
[in] dwReasonLength
Тип: DWORD
Длина pvReason в байтах.
Если параметр pvReason имеет значение NULL, это значение должно быть равно 0. Это значение должно находиться в диапазоне от 0 до 123.
Возвращаемое значение
Тип: DWORD
За следующим исключением все коды ошибок указывают на то, что базовое TCP-подключение прервано.
| Описание | |
|---|---|
|
Ожидается закрытие или отправка. |
|
Недопустимый параметр. |
|
С сервера получены недопустимые данные. |
Комментарии
WinHttpWebSocketClose полностью закрывает подключение WebSocket. Чтобы закрыть канал отправки, оставив его открытым, используйте WinHttpWebSocketShutdown.
При выполнении регулярных операций получения можно получить близкий кадр. В этом случае WinHttpWebSocketClose также отправит закрывающий кадр.
Таймер закрытия можно задать с помощью свойства WINHTTP_OPTION_WEB_SOCKET_CLOSE_TIMEOUT. Значение по умолчанию — 10 секунд.
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | Windows 8 [только классические приложения] |
| Минимальная версия сервера | Windows Server 2012 [только классические приложения] |
| Целевая платформа | Windows |
| Header | winhttp.h |
| Библиотека | Winhttp.lib |
| DLL | Winhttp.dll |