Funzione WebSocketReceive (websocket.h)

La funzione WebSocketReceive aggiunge un'operazione di ricezione alla coda di operazioni del componente del protocollo.

Sintassi

HRESULT WebSocketReceive(
  [in]           WEB_SOCKET_HANDLE hWebSocket,
  [in, optional] WEB_SOCKET_BUFFER *pBuffer,
  [in, optional] PVOID             pvContext
);

Parametri

[in] hWebSocket

Tipo: WEB_SOCKET_HANDLE

Handle di sessione WebSocket restituito da una chiamata precedente a WebSocketCreateClientHandle o WebSocketCreateServerHandle.

[in, optional] pBuffer

Tipo: WEB_SOCKET_BUFFER*

Puntatore a una matrice di strutture WEB_SOCKET_BUFFER a cui verranno scritti i dati WebSocket quando viene restituito da WebSocketGetAction. Se NULL, WebSocketGetAction restituirà un buffer interno che consente scenari di copia zero.

Nota Una volta restituito WEB_SOCKET_INDICATE_RECEIVE_COMPLETE da WebSocketGetAction per questa azione, è possibile recuperare il puntatore alla memoria da pBuffer .

 

[in, optional] pvContext

Tipo: PVOID

Puntatore a un handle di contesto dell'applicazione che verrà restituito da una chiamata successiva a WebSocketGetAction.

Valore restituito

Tipo: HRESULT

Se la funzione ha esito positivo, restituisce S_OK.

Se la funzione ha esito negativo, restituisce uno dei seguenti o un codice di errore di sistema definito in WinError.h.

Codice restituito	Descrizione
E_INVALID_PROTOCOL_OPERATION	Protocollo eseguito un'operazione non valida.

Requisiti

Requisito	Valore
Client minimo supportato	Windows 8 [solo app desktop]
Server minimo supportato	Windows Server 2012 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	websocket.h
Libreria	Websocket.lib
DLL	Websocket.dll

Vedi anche

WEB_SOCKET_ACTION

WebSocketAbortHandle

WebSocketCompleteAction

WebSocketGetAction

WebSocketSend