Funzione WinHttpWebSocketReceive (winhttp.h)

  • Articolo

La funzione WinHttpWebSocketReceive riceve i dati da una connessione WebSocket.

Sintassi

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

Parametri

[in] hWebSocket

Tipo: SUBNETNET

Gestire in un WebSocket.

[out] pvBuffer

Tipo: PVOID

Puntatore a un buffer per ricevere i dati.

[in] dwBufferLength

Tipo: DWORD

Lunghezza in byte di pvBuffer.

[out] pdwBytesRead

Tipo: DWORD*

Puntatore a un DWORD che riceve il numero di byte letti dalla connessione alla fine dell'operazione. Viene impostato solo se WinHttpWebSocketReceive restituisce NO_ERROR e l'handle è stato aperto in modalità sincrona.

[out] peBufferType

Tipo: WINHTTP_WEB_SOCKET_BUFFER_TYPE*

Tipo di un buffer restituito. Questa impostazione viene impostata solo se WinHttpWebSocketReceive restituisce NO_ERROR e l'handle è stato aperto in modalità sincrona.

Valore restituito

Tipo: DWORD

NO_ERROR al successo. In caso contrario, un codice di errore.

Descrizione
ERROR_INVALID_OPERATION
 Una ricezione o una chiusura è in sospeso oppure il canale di ricezione è già stato chiuso.
ERROR_INVALID_PARAMETER
 Un parametro non è valido.
ERROR_WINHTTP_INVALID_SERVER_RESPONSE
 I dati non validi sono stati ricevuti dal server.
ERROR_WINHTTP_OPERATION_CANCELLED
 L'operazione è stata annullata perché WinHttpWebSocketClose è stato chiamato per chiudere la connessione.

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