WinHttpWebSocketShutdown-Funktion (winhttp.h)
Die WinHttpWebSocketShutdown-Funktion sendet einen close Frame an einen WebSocket-Server, um den Sendekanal zu schließen, lässt den Empfangskanal jedoch geöffnet.
Syntax
WINHTTPAPI DWORD WinHttpWebSocketShutdown(
[in] HINTERNET hWebSocket,
[in] USHORT usStatus,
[in, optional] PVOID pvReason,
[in] DWORD dwReasonLength
);
Parameter
[in] hWebSocket
Typ: HINTERNET
Handle mit einem WebSocket.
[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 | |
|---|---|
|
Der Vorgang wird asynchron abgeschlossen. |
Hinweise
WinHttpWebSocketShutdown sendet einen close Frame und verhindert, dass zusätzliche Daten über die WebSocket-Verbindung gesendet werden. Der Empfangskanal wird nicht geschlossen. Verwenden Sie WinHttpWebSocketClose , wenn Sie die Verbindung vollständig schließen und nachfolgende Empfangsvorgänge verhindern möchten.
Die Anwendung ist für den Empfang des CloseFrames vom Server (über reguläre Empfangsvorgänge) verantwortlich.
Nachdem WinHttpWebSocketShutdown aufgerufen wurde, kann die Anwendung WinHttpWebSocketClose aufrufen, wenn sie keinen eigenen close Frame empfangen und an den Stapel delegieren möchte.
Anforderungen
| 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 |