WinHttpWebSocketQueryCloseStatus-Funktion (winhttp.h)

Artikel
08/27/2023

Die WinHttpWebSocketQueryCloseStatus-Funktion ruft die von einem Server gesendete schließen status ab.

Syntax

WINHTTPAPI DWORD WinHttpWebSocketQueryCloseStatus(
  [in]  HINTERNET hWebSocket,
  [out] USHORT    *pusStatus,
  [out] PVOID     pvReason,
  [in]  DWORD     dwReasonLength,
  [out] DWORD     *pdwReasonLengthConsumed
);

Parameter

[in] hWebSocket

Typ: HINTERNET

Handle to a WebSocket

[out] pusStatus

Typ: USHORT*

Ein Zeiger auf einen schließenden status Code, der bei der Rückgabe ausgefüllt wird. Mögliche Werte finden Sie unter WINHTTP_WEB_SOCKET_CLOSE_STATUS .

[out] pvReason

Typ: PVOID

Ein Zeiger auf einen Puffer, der bei der Rückgabe einen schließenden Grund erhält.

[in] dwReasonLength

Art: DWORD

Die Länge des pvReason-Puffers in Bytes.

[out] pdwReasonLengthConsumed

Typ: DWORD*

Die Anzahl der verbrauchten Bytes. Wenn pvReasonNULL und dwReasonLength 0 ist, enthält pdwReasonLengthConsumed die Größe des Puffers, der von der aufrufenden Anwendung zugeordnet werden muss.

Rückgabewert

Art: DWORD

NO_ERROR auf Erfolg. Andernfalls ein Fehlercode.

	BESCHREIBUNG
ERROR_INSUFFICIENT_BUFFER	Es ist nicht genug Platz in pvReason , um den gesamten schließenden Grund zu schreiben.
ERROR_INVALID_OPERATION	Es wurde noch kein close frame empfangen.
ERROR_INVALID_PARAMETER	Ein Parameter ist ungültig.

Hinweise

Rufen Sie WinHttpWebSocketQueryCloseStatus erst auf, nachdem WinHttpWebSocketClose erfolgreich war oder wenn WinHttpWebSocketReceiveWINHTTP_WEB_SOCKET_CLOSE_BUFFER_TYPE zurückgibt.

pdwReasonLengthConsumed ist niemals größer als 123, sodass das Zuweisen des Puffers mit mindestens 123 garantiert, dass ERROR_INSUFFICIENT_BUFFER niemals zurückgegeben wird.

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

WinHttpWebSocketClose

WinHttpWebSocketReceive

Freigeben über