Funzione WebSocketCompleteAction (websocket.h)

La funzione WebSocketCompleteAction completa un'azione avviata da WebSocketGetAction.

Sintassi

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

Parametri

[in] hWebSocket

Tipo: WEB_SOCKET_HANDLE

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

[in] pvActionContext

Tipo: PVOID

Puntatore a un handle del contesto di azione restituito da una chiamata precedente a WebSocketGetAction.

[in] ulBytesTransferred

Tipo: ULONG

Numero di byte trasferiti per le azioni WEB_SOCKET_SEND_TO_NETWORK_ACTION o WEB_SOCKET_RECEIVE_FROM_NETWORK_ACTION . Questo valore deve essere 0 per tutte le altre azioni.

Valore restituito

Se la funzione ha esito positivo, restituisce S_OK.

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

Commenti

Ogni chiamata a WebSocketGetAction deve essere associata a una chiamata a WebSocketCompleteAction. Per le azioni di rete seguenti, possono verificarsi errori di I/O:

• WEB_SOCKET_SEND_TO_NETWORK_ACTION: se ulBytesTransferred è diverso dalla somma di tutte le lunghezze del buffer restituite da WebSocketGetAction , l'azione di invio corrente viene annullata e la chiamata successiva a WebSocketGetAction restituirà WEB_SOCKET_INDICATE_SEND_COMPLETE_ACTION anche se non tutti i buffer passati a WebSocketSend sono stati elaborati.
• WEB_SOCKET_RECEIVE_FROM_NETWORK_ACTION: se ulBytesTransferred è 0, l'azione di ricezione corrente viene annullata e la chiamata successiva a WebSocketGetAction restituirà WEB_SOCKET_INDICATE_RECEIVE_COMPLETE_ACTION anche se non tutti i buffer passati a WebSocketReceive sono stati elaborati.

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

WebSocketGetAction