Fonction WebSocketCompleteAction (websocket.h)

Article
08/27/2023

La fonction WebSocketCompleteAction termine une action démarrée par WebSocketGetAction.

Syntaxe

void WebSocketCompleteAction(
  [in] WEB_SOCKET_HANDLE hWebSocket,
  [in] PVOID             pvActionContext,
  [in] ULONG             ulBytesTransferred
);

Paramètres

[in] hWebSocket

Type : WEB_SOCKET_HANDLE

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

[in] pvActionContext

Type : PVOID

Pointeur vers un handle de contexte d’action qui a été retourné par un appel précédent à WebSocketGetAction.

[in] ulBytesTransferred

Type : ULONG

Nombre d’octets transférés pour les actions WEB_SOCKET_SEND_TO_NETWORK_ACTION ou WEB_SOCKET_RECEIVE_FROM_NETWORK_ACTION . Cette valeur doit être 0 pour toutes les autres actions.

Valeur retournée

Si la fonction réussit, elle retourne S_OK.

Si la fonction échoue, elle retourne un code d’erreur système défini dans WinError.h.

Remarques

Chaque appel à WebSocketGetAction doit être associé à un appel à WebSocketCompleteAction. Pour les actions réseau suivantes, des erreurs d’E/S peuvent se produire :

WEB_SOCKET_SEND_TO_NETWORK_ACTION : si ulBytesTransferred est différent de la somme de toutes les longueurs de mémoire tampon retournées par WebSocketGetAction , l’action d’envoi actuelle est annulée et l’appel suivant à WebSocketGetAction renvoie WEB_SOCKET_INDICATE_SEND_COMPLETE_ACTION même si toutes les mémoires tampons passées à WebSocketSend n’ont pas été traitées.
WEB_SOCKET_RECEIVE_FROM_NETWORK_ACTION : si ulBytesTransferred a la valeur 0, l’action de réception actuelle est annulée et l’appel suivant à WebSocketGetAction retourne WEB_SOCKET_INDICATE_RECEIVE_COMPLETE_ACTION même si toutes les mémoires tampons passées à WebSocketReceive n’ont pas été traitées.

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

WebSocketGetAction

Partager via