WinHttpWebSocketClose-Funktion (winhttp.h)

Artikel
08/27/2023

Die WinHttpWebSocketClose-Funktion schließt eine WebSocket-Verbindung.

Syntax

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

Parameter

[in] hWebSocket

Typ: HINTERNET

Handle mit einem WebSocket.

HinweisWinHttpWebSocketClose schließt dieses Handle nicht. Um das Handle zu schließen, rufen Sie WinHttpCloseHandle auf hWebSocket auf, sobald es nicht mehr benötigt wird.

[in] usStatus

Typ: USHORT

Ein code close status. Mögliche Werte finden Sie unter WINHTTP_WEB_SOCKET_CLOSE_STATUS .

[in, optional] pvReason

Typ: PVOID

Ein ausführlicher Grund für die Schließung.

[in] dwReasonLength

Art: DWORD

Die Länge von pvReason in Bytes.

Wenn pvReason NULL ist, muss dies 0 sein. Dieser Wert muss im Bereich von 0 bis 123 liegen.

Rückgabewert

Art: DWORD

Mit der folgenden Ausnahme geben alle Fehlercodes an, dass die zugrunde liegende TCP-Verbindung abgebrochen wurde.

	BESCHREIBUNG
ERROR_INVALID_OPERATION	Ein Schließen oder Senden steht aus.
ERROR_INVALID_PARAMETER	Ein Parameter ist ungültig.
ERROR_INVALID_SERVER_RESPONSE	Vom Server wurden ungültige Daten empfangen.

Hinweise

WinHttpWebSocketClose schließt eine WebSocket-Verbindung vollständig. Verwenden Sie WinHttpWebSocketShutdown, um den Sendekanal zu schließen, während der Empfangskanal geöffnet bleibt.

Es ist möglich, während regulärer Empfangsvorgänge einen close Frame zu erhalten. In diesem Fall sendet WinHttpWebSocketClose auch einen close Frame.

Der Close-Timer kann durch die Eigenschaft WINHTTP_OPTION_WEB_SOCKET_CLOSE_TIMEOUT festgelegt werden. Die Standardeinstellung beträgt 10 Sekunden.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 8 [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2012 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	winhttp.h
Bibliothek	Winhttp.lib
DLL	Winhttp.dll

Weitere Informationen

WINHTTP_WEB_SOCKET_CLOSE_STATUS

WinHttpCloseHandle

WinHttpWebSocketShutdown

Freigeben über