Função WebSocketCompleteAction (websocket.h)
A função WebSocketCompleteAction conclui uma ação iniciada por WebSocketGetAction.
Sintaxe
void WebSocketCompleteAction(
[in] WEB_SOCKET_HANDLE hWebSocket,
[in] PVOID pvActionContext,
[in] ULONG ulBytesTransferred
);
Parâmetros
[in] hWebSocket
Tipo: WEB_SOCKET_HANDLE
Identificador de sessão WebSocket retornado por uma chamada anterior para WebSocketCreateClientHandle ou WebSocketCreateServerHandle.
[in] pvActionContext
Tipo: PVOID
Ponteiro para um identificador de contexto de ação que foi retornado por uma chamada anterior para WebSocketGetAction.
[in] ulBytesTransferred
Tipo: ULONG
Número de bytes transferidos para as ações de WEB_SOCKET_SEND_TO_NETWORK_ACTION ou WEB_SOCKET_RECEIVE_FROM_NETWORK_ACTION . Esse valor deve ser 0 para todas as outras ações.
Retornar valor
Se a função for bem-sucedida, ela retornará S_OK.
Se a função falhar, ela retornará um código de erro do sistema definido em WinError.h.
Comentários
Cada chamada para WebSocketGetAction deve ser emparelhada com uma chamada para WebSocketCompleteAction. Para as seguintes ações de rede, erros de E/S podem ocorrer:
- WEB_SOCKET_SEND_TO_NETWORK_ACTION: se ulBytesTransferred for diferente da soma, todos os comprimentos de buffer retornados de WebSocketGetAction a ação de envio atual será cancelada e a próxima chamada para WebSocketGetAction retornará WEB_SOCKET_INDICATE_SEND_COMPLETE_ACTION mesmo que nem todos os buffers passados para WebSocketSend tenham sido processados.
- WEB_SOCKET_RECEIVE_FROM_NETWORK_ACTION: se ulBytesTransferred for 0, a ação de recebimento atual será cancelada e a próxima chamada para WebSocketGetAction retornará WEB_SOCKET_INDICATE_RECEIVE_COMPLETE_ACTION mesmo que nem todos os buffers passados para WebSocketReceive tenham sido processados.
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Windows 8 [somente aplicativos da área de trabalho] |
| Servidor mínimo com suporte | Windows Server 2012 [somente aplicativos da área de trabalho] |
| Plataforma de Destino | Windows |
| Cabeçalho | websocket.h |
| Biblioteca | Websocket.lib |
| DLL | Websocket.dll |