WinHttpWebSocketReceive-Funktion (winhttp.h)

Artikel
03/15/2023

Die WinHttpWebSocketReceive-Funktion empfängt Daten von einer WebSocket-Verbindung.

Syntax

WINHTTPAPI DWORD WinHttpWebSocketReceive(
  [in]  HINTERNET                      hWebSocket,
  [out] PVOID                          pvBuffer,
  [in]  DWORD                          dwBufferLength,
  [out] DWORD                          *pdwBytesRead,
  [out] WINHTTP_WEB_SOCKET_BUFFER_TYPE *peBufferType
);

Parameter

[in] hWebSocket

Typ: HINTERNET

Handle mit einem WebSocket.

[out] pvBuffer

Typ: PVOID

Zeiger auf einen Puffer, um die Daten zu empfangen.

[in] dwBufferLength

Art: DWORD

Länge von pvBuffer in Bytes.

[out] pdwBytesRead

Typ: DWORD*

Zeiger auf ein DWORD , das die Anzahl von Bytes empfängt, die am Ende des Vorgangs von der Verbindung gelesen werden. Dies wird nur festgelegt, wenn WinHttpWebSocketReceiveNO_ERROR zurückgibt und das Handle im synchronen Modus geöffnet wurde.

[out] peBufferType

Typ: WINHTTP_WEB_SOCKET_BUFFER_TYPE*

Der Typ eines zurückgegebenen Puffers. Dies wird nur festgelegt, wenn WinHttpWebSocketReceiveNO_ERROR zurückgibt und das Handle im synchronen Modus geöffnet wurde.

Rückgabewert

Art: DWORD

NO_ERROR auf Erfolg. Andernfalls ein Fehlercode.

	BESCHREIBUNG
ERROR_INVALID_OPERATION	Ein Schließen oder Empfangen steht aus, oder der Empfangskanal wurde bereits geschlossen.
ERROR_INVALID_PARAMETER	Ein Parameter ist ungültig.
ERROR_WINHTTP_INVALID_SERVER_RESPONSE	Vom Server wurden ungültige Daten empfangen.
ERROR_WINHTTP_OPERATION_CANCELLED	Der Vorgang wurde abgebrochen, weil WinHttpWebSocketClose aufgerufen wurde, um die Verbindung zu schließen.

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