Função WebSocketReceive (websocket.h)
A função WebSocketReceive adiciona uma operação de recebimento à fila de operações do componente de protocolo.
Sintaxe
HRESULT WebSocketReceive(
[in] WEB_SOCKET_HANDLE hWebSocket,
[in, optional] WEB_SOCKET_BUFFER *pBuffer,
[in, optional] PVOID pvContext
);
Parâmetros
[in] hWebSocket
Tipo: WEB_SOCKET_HANDLE
Identificador de sessão WebSocket retornado por uma chamada anterior para WebSocketCreateClientHandle ou WebSocketCreateServerHandle.
[in, optional] pBuffer
Tipo: WEB_SOCKET_BUFFER*
Um ponteiro para uma matriz de estruturas WEB_SOCKET_BUFFER nas quais os dados do WebSocket serão gravados quando forem retornados por WebSocketGetAction. Se NULL, WebSocketGetAction retornará um buffer interno que habilita cenários de cópia zero.
[in, optional] pvContext
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. |
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 |