Función WinHttpWebSocketClose (winhttp.h)

La función WinHttpWebSocketClose cierra una conexión WebSocket.

Sintaxis

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

Parámetros

[in] hWebSocket

Tipo: HINTERNET

Identificador de un WebSocket.

NotaWinHttpWebSocketClose no cierra este identificador. Para cerrar el identificador, llame a WinHttpCloseHandle en hWebSocket una vez que ya no sea necesario.

 

[in] usStatus

Tipo: USHORT

Código de estado de cierre. Consulte WINHTTP_WEB_SOCKET_CLOSE_STATUS para conocer los valores posibles.

[in, optional] pvReason

Tipo: PVOID

Motivo detallado del cierre.

[in] dwReasonLength

Tipo: DWORD

Longitud de pvReason, en bytes.

Si pvReason es NULL, debe ser 0. Este valor debe estar dentro del intervalo de 0 a 123.

Valor devuelto

Tipo: DWORD

Con la siguiente excepción, todos los códigos de error indican que se ha anulado la conexión TCP subyacente.

	Descripción
ERROR_INVALID_OPERATION	Hay pendiente un cierre o envío.
ERROR_INVALID_PARAMETER	Si se devuelve este valor, significará que el parámetro en cuestión no es válido.
ERROR_INVALID_SERVER_RESPONSE	Se recibieron datos no válidos del servidor.

Comentarios

WinHttpWebSocketClose cierra completamente una conexión WebSocket. Para cerrar el canal de envío mientras deja abierto el canal de recepción, use WinHttpWebSocketShutdown.

Es posible recibir un marco de cierre durante las operaciones periódicas de recepción. En este caso, WinHttpWebSocketClose también enviará un fotograma de cierre.

El temporizador de cierre se puede establecer mediante la propiedad WINHTTP_OPTION_WEB_SOCKET_CLOSE_TIMEOUT. El valor predeterminado es 10 segundos.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 8 [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2012 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winhttp.h
Library	Winhttp.lib
Archivo DLL	Winhttp.dll

Consulte también

WINHTTP_WEB_SOCKET_CLOSE_STATUS

WinHttpCloseHandle

WinHttpWebSocketShutdown