Fonction WebSocketReceive (websocket.h)

Article
03/03/2024

La fonction WebSocketReceive ajoute une opération de réception à la file d’attente d’opérations du composant de protocole.

Syntaxe

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

Paramètres

[in] hWebSocket

Type : WEB_SOCKET_HANDLE

Handle de session WebSocket retourné par un appel précédent à WebSocketCreateClientHandle ou WebSocketCreateServerHandle.

[in, optional] pBuffer

Type : WEB_SOCKET_BUFFER*

Pointeur vers un tableau de structures WEB_SOCKET_BUFFER dans laquelle les données WebSocket sont écrites lorsqu’elles sont retournées par WebSocketGetAction. Si la valeur est NULL, WebSocketGetAction retourne une mémoire tampon interne qui active les scénarios de copie zéro.

Note Une fois que WEB_SOCKET_INDICATE_RECEIVE_COMPLETE est retourné par WebSocketGetAction pour cette action, le pointeur de mémoire vers par pBuffer peut être récupéré.

[in, optional] pvContext

Type : PVOID

Pointeur vers un handle de contexte d’application qui sera retourné par un appel ultérieur à WebSocketGetAction.

Valeur retournée

Type : HRESULT

Si la fonction réussit, elle retourne S_OK.

Si la fonction échoue, elle retourne l’un des codes d’erreur système suivants ou définis dans WinError.h.

Code de retour	Description
E_INVALID_PROTOCOL_OPERATION	Le protocole a effectué une opération non valide.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 8 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2012 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	websocket.h
Bibliothèque	Websocket.lib
DLL	Websocket.dll

Voir aussi

WEB_SOCKET_ACTION

WebSocketAbortHandle

WebSocketCompleteAction

WebSocketGetAction

WebSocketSend

Partager via