Función WebSocketCompleteAction (websocket.h)
La función WebSocketCompleteAction completa una acción iniciada por WebSocketGetAction.
Sintaxis
void WebSocketCompleteAction(
[in] WEB_SOCKET_HANDLE hWebSocket,
[in] PVOID pvActionContext,
[in] ULONG ulBytesTransferred
);
Parámetros
[in] hWebSocket
Tipo: WEB_SOCKET_HANDLE
Identificador de sesión de WebSocket devuelto por una llamada anterior a WebSocketCreateClientHandle o WebSocketCreateServerHandle.
[in] pvActionContext
Tipo: PVOID
Puntero a un identificador de contexto de acción devuelto por una llamada anterior a WebSocketGetAction.
[in] ulBytesTransferred
Tipo: ULONG
Número de bytes transferidos para las acciones de WEB_SOCKET_SEND_TO_NETWORK_ACTION o WEB_SOCKET_RECEIVE_FROM_NETWORK_ACTION . Este valor debe ser 0 para todas las demás acciones.
Valor devuelto
Si la función se realiza correctamente, devuelve S_OK.
Si se produce un error en la función, devuelve un código de error del sistema definido en WinError.h.
Comentarios
Cada llamada a WebSocketGetAction debe emparejarse con una llamada a WebSocketCompleteAction. Para las siguientes acciones de red, pueden producirse errores de E/S:
- WEB_SOCKET_SEND_TO_NETWORK_ACTION: si ulBytesTransferred es diferente de la suma de todas las longitudes de búfer devueltas de WebSocketGetAction , se cancela la acción de envío actual y la siguiente llamada a WebSocketGetAction devolverá WEB_SOCKET_INDICATE_SEND_COMPLETE_ACTION incluso si no se procesaron todos los búferes pasados a WebSocketSend .
- WEB_SOCKET_RECEIVE_FROM_NETWORK_ACTION: si ulBytesTransferred es 0, se cancela la acción de recepción actual y la siguiente llamada a WebSocketGetAction devolverá WEB_SOCKET_INDICATE_RECEIVE_COMPLETE_ACTION incluso si no se procesaron todos los búferes pasados a WebSocketReceive .
Requisitos
| Requisito | Value |
|---|---|
| Cliente mínimo compatible | Windows 8 [solo aplicaciones de escritorio] |
| Servidor mínimo compatible | Windows Server 2012 [solo aplicaciones de escritorio] |
| Plataforma de destino | Windows |
| Encabezado | websocket.h |
| Library | Websocket.lib |
| Archivo DLL | Websocket.dll |