Função WinHttpWebSocketClose (winhttp.h)

A função WinHttpWebSocketClose fecha uma conexão WebSocket.

Sintaxe

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

Parâmetros

[in] hWebSocket

Tipo: HINTERNET

Manipule para um WebSocket.

ObservaçãoWinHttpWebSocketClose não fecha esse identificador. Para fechar o identificador, chame WinHttpCloseHandle em hWebSocket depois que ele não for mais necessário.

[in] usStatus

Tipo: USHORT

Um código de status próximo. Confira WINHTTP_WEB_SOCKET_CLOSE_STATUS para obter valores possíveis.

[in, optional] pvReason

Tipo: PVOID

Um motivo detalhado para o fechamento.

[in] dwReasonLength

Tipo: DWORD

O comprimento de pvReason, em bytes.

Se pvReason for NULL, ele deverá ser 0. Esse valor deve estar dentro do intervalo de 0 a 123.

Retornar valor

Tipo: DWORD

Com a exceção a seguir, todos os códigos de erro indicam que a conexão TCP subjacente foi anulada.

	Descrição
ERROR_INVALID_OPERATION	Um fechamento ou envio está pendente.
ERROR_INVALID_PARAMETER	Um parâmetro é inválido.
ERROR_INVALID_SERVER_RESPONSE	Dados inválidos foram recebidos do servidor.

Comentários

WinHttpWebSocketClose fecha completamente uma conexão WebSocket. Para fechar o canal de envio enquanto ainda deixa o canal de recebimento aberto, use WinHttpWebSocketShutdown.

É possível receber um quadro próximo durante operações de recebimento regulares. Nesse caso, WinHttpWebSocketClose também enviará um quadro de fechamento.

O temporizador de fechamento pode ser definido pela propriedade WINHTTP_OPTION_WEB_SOCKET_CLOSE_TIMEOUT. O padrão é 10 segundos.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 8 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2012 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winhttp.h
Biblioteca	Winhttp.lib
DLL	Winhttp.dll