Função WebSocketSend (websocket.h)
A função WebSocketSend adiciona uma operação de envio à fila de operações do componente de protocolo.
Sintaxe
HRESULT WebSocketSend(
[in] WEB_SOCKET_HANDLE hWebSocket,
[in] WEB_SOCKET_BUFFER_TYPE BufferType,
[in, optional] WEB_SOCKET_BUFFER *pBuffer,
[in, optional] PVOID Context
);
Parâmetros
[in] hWebSocket
Tipo: WEB_SOCKET_HANDLE
Identificador de sessão WebSocket retornado por uma chamada anterior para WebSocketCreateClientHandle ou WebSocketCreateServerHandle.
[in] BufferType
Tipo: WEB_SOCKET_BUFFER_TYPE
O tipo de dados de buffer WebSocket a serem enviados no pBuffer.
[in, optional] pBuffer
Tipo: WEB_SOCKET_BUFFER*
Um ponteiro para uma matriz de estruturas de WEB_SOCKET_BUFFER que contém dados de buffer WebSocket a serem enviados. Se BufferType for WEB_SOCKET_PING_PONG_BUFFER_TYPE ou WEB_SOCKET_UNSOLICITED_PONG_BUFFER_TYPE, pBuffer deverá ser NULL.
[in, optional] Context
Tipo: PVOID
Um ponteiro para um identificador de contexto de aplicativo que será retornado por uma chamada subsequente para WebSocketGetAction.
Retornar valor
Tipo: HRESULT
Se a função for bem-sucedida, ela retornará S_OK.
Se a função falhar, ela retornará uma das opções a seguir ou um código de erro do sistema definido em WinError.h.
| Código de retorno | Descrição |
|---|---|
|
O protocolo executou uma operação inválida. |
Comentários
Depois que um aplicativo envia um WEB_SOCKET_CLOSE_BUFFER_TYPE buffer WebSocket com êxito, ele só pode enviar quadros de controle.
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 |