Funzione WinHttpWebSocketShutdown (winhttp.h)

Articolo
08/27/2023

La funzione WinHttpWebSocketShutdown invia un frame di chiusura a un server WebSocket per chiudere il canale di invio, ma lascia aperto il canale di ricezione.

Sintassi

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

Parametri

[in] hWebSocket

Tipo: HINTERNET

Gestire in un WebSocket.

NotaWinHttpWebSocketShutdown non chiude questo handle. Per chiudere l'handle, chiamare WinHttpCloseHandle in 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

Un motivo dettagliato per la chiusura.

[in] dwReasonLength

Tipo: DWORD

Lunghezza di pvReason, in byte.

Se pvReason è NULL, questo 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_IO_PENDING	L'operazione verrà completata in modo asincrono.

Commenti

WinHttpWebSocketShutdown invia un frame di chiusura e impedisce l'invio di dati aggiuntivi tramite la connessione WebSocket. Non chiude il canale di ricezione. Usare WinHttpWebSocketClose quando si vuole chiudere completamente la connessione e impedire eventuali operazioni di ricezione successive.

L'applicazione è responsabile della ricezione del frame di chiusura dal server (tramite operazioni di ricezione regolari).

Dopo aver chiamato WinHttpWebSocketShutdown , l'applicazione può chiamare WinHttpWebSocketClose se non vuole ricevere un frame di chiusura in modo autonomo e delegarlo allo stack.

Requisiti


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

WinHttpWebSocketClose

Condividi tramite