Funzione WinHttpWebSocketClose (winhttp.h)

Articolo
03/04/2024

La funzione WinHttpWebSocketClose chiude una connessione WebSocket.

Sintassi

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

Parametri

[in] hWebSocket

Tipo: SUBNETNET

Gestire in un WebSocket.

NotaWinHttpWebSocketClose non chiude questo handle. Per chiudere l'handle, chiama WinHttpCloseHandle su hWebSocket una volta che non è più necessario.

[in] usStatus

Tipo: USHORT

Codice di stato di chiusura. Per i valori possibili, vedere WINHTTP_WEB_SOCKET_CLOSE_STATUS.

[in, optional] pvReason

Tipo: PVOID

Motivo dettagliato della chiusura.

[in] dwReasonLength

Tipo: DWORD

Lunghezza in byte di pvReason.

Se pvReason è NULL, deve essere 0. Questo valore deve essere compreso nell'intervallo compreso tra 0 e 123.

Valore restituito

Tipo: DWORD

Con l'eccezione seguente, tutti i codici di errore indicano che la connessione TCP sottostante è stata interrotta.

	Descrizione
ERROR_INVALID_OPERATION	Un'operazione di chiusura o invio è in sospeso.
ERROR_INVALID_PARAMETER	Un parametro non è valido.
ERROR_INVALID_SERVER_RESPONSE	I dati non validi sono stati ricevuti dal server.

Commenti

WinHttpWebSocketClose chiude completamente una connessione WebSocket. Per chiudere il canale di invio lasciando aperto il canale di ricezione, usare WinHttpWebSocketShutdown.

È possibile ricevere un frame di chiusura durante le normali operazioni di ricezione. In questo caso , WinHttpWebSocketClose invierà anche un frame di chiusura.

Il timer di chiusura può essere impostato dalla proprietà WINHTTP_OPTION_WEB_SOCKET_CLOSE_TIMEOUT. Il valore predefinito è 10 secondi.

Requisiti

Requisito	Valore
Client minimo supportato	Windows 8 [solo app desktop]
Server minimo supportato	Windows Server 2012 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	winhttp.h
Libreria	Winhttp.lib
DLL	Winhttp.dll

Vedi anche

WINHTTP_WEB_SOCKET_CLOSE_STATUS

WinHttpCloseHandle

WinHttpWebSocketShutdown

Condividi tramite