Função WinHttpWebSocketShutdown (winhttp.h)
A função WinHttpWebSocketShutdown envia um quadro próximo a um servidor WebSocket para fechar o canal de envio, mas deixa o canal de recebimento aberto.
Sintaxe
WINHTTPAPI DWORD WinHttpWebSocketShutdown(
[in] HINTERNET hWebSocket,
[in] USHORT usStatus,
[in, optional] PVOID pvReason,
[in] DWORD dwReasonLength
);
Parâmetros
[in] hWebSocket
Tipo: HINTERNET
Manipule para um WebSocket.
[in] usStatus
Tipo: USHORT
Um código de status próximo. Consulte 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, isso deverá ser 0. Esse valor deve estar dentro do intervalo de 0 a 123.
Valor retornado
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 | |
|---|---|
|
A operação será concluída de forma assíncrona. |
Comentários
WinHttpWebSocketShutdown envia um quadro próximo e impede que dados adicionais sejam enviados pela conexão WebSocket. Ele não fecha o canal de recebimento. Use WinHttpWebSocketClose quando quiser fechar completamente a conexão e impedir operações de recebimento subsequentes.
O aplicativo é responsável por receber o quadro de fechamento do servidor (por meio de operações de recebimento regulares).
Depois que WinHttpWebSocketShutdown for chamado, o aplicativo poderá chamar WinHttpWebSocketClose se não quiser receber um quadro próximo por conta própria e delegá-lo à pilha.
Requisitos
| 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 |