Функция WinHttpWebSocketShutdown (winhttp.h)

Статья
08/27/2023

Функция WinHttpWebSocketShutdown отправляет близкий кадр на сервер WebSocket, чтобы закрыть канал отправки, но оставляет канал получения открытым.

Синтаксис

WINHTTPAPI DWORD WinHttpWebSocketShutdown(
  [in]           HINTERNET hWebSocket,
  [in]           USHORT    usStatus,
  [in, optional] PVOID     pvReason,
  [in]           DWORD     dwReasonLength
);

Параметры

[in] hWebSocket

Тип: HINTERNET

Обработка в WebSocket.

Примечание. WinHttpWebSocketShutdown не закрывает этот дескриптор. Чтобы закрыть дескриптор, вызовите WinHttpCloseHandle в hWebSocket , когда он больше не нужен.

[in] usStatus

Тип: USHORT

Код состояния закрытия. Возможные значения см. в WINHTTP_WEB_SOCKET_CLOSE_STATUS .

[in, optional] pvReason

Тип: PVOID

Подробная причина закрытия.

[in] dwReasonLength

Тип: DWORD

Длина pvReason в байтах.

Если параметр pvReason имеет значение NULL, это значение должно быть равно 0. Это значение должно находиться в диапазоне от 0 до 123.

Возвращаемое значение

Тип: DWORD

За следующим исключением все коды ошибок указывают на то, что базовое TCP-подключение прервано.

	Описание
ERROR_IO_PENDING	Операция будет завершена асинхронно.

WinHttpWebSocketShutdown отправляет близкий кадр и предотвращает отправку дополнительных данных через подключение WebSocket. Канал получения не закрывается. Используйте WinHttpWebSocketClose , если вы хотите полностью закрыть подключение и предотвратить любые последующие операции получения.

Приложение отвечает за получение близкого кадра с сервера (с помощью регулярных операций получения).

После вызова WinHttpWebSocketShutdown приложение может вызвать WinHttpWebSocketClose , если оно не хочет самостоятельно получать близкий кадр и делегировать его стеку.

Требования


Минимальная версия клиента	Windows 8 [только классические приложения]
Минимальная версия сервера	Windows Server 2012 [только классические приложения]
Целевая платформа	Windows
Header	winhttp.h
Библиотека	Winhttp.lib
DLL	Winhttp.dll

См. также раздел

WINHTTP_WEB_SOCKET_CLOSE_STATUS

WinHttpCloseHandle

WinHttpWebSocketClose

Поделиться через