Funzione WebSocketSend (websocket.h)

Articolo
03/13/2024

La funzione WebSocketSend aggiunge un'operazione di invio alla coda di operazioni del componente del protocollo.

Sintassi

HRESULT WebSocketSend(
  [in]           WEB_SOCKET_HANDLE      hWebSocket,
  [in]           WEB_SOCKET_BUFFER_TYPE BufferType,
  [in, optional] WEB_SOCKET_BUFFER      *pBuffer,
  [in, optional] PVOID                  Context
);

Parametri

[in] hWebSocket

Tipo: WEB_SOCKET_HANDLE

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

[in] BufferType

Tipo: WEB_SOCKET_BUFFER_TYPE

Tipo di dati del buffer WebSocket da inviare in pBuffer.

[in, optional] pBuffer

Tipo: WEB_SOCKET_BUFFER*

Puntatore a una matrice di strutture WEB_SOCKET_BUFFER che contiene i dati del buffer WebSocket da inviare. Se BufferType è WEB_SOCKET_PING_PONG_BUFFER_TYPE o WEB_SOCKET_UNSOLICITED_PONG_BUFFER_TYPE, pBuffer deve essere NULL.

Nota Una volta restituito WEB_SOCKET_INDICATE_SEND_COMPLETE da WebSocketGetAction per questa azione, è possibile recuperare il puntatore alla memoria da pBuffer .

[in, optional] Context

Tipo: PVOID

Puntatore a un handle di contesto dell'applicazione che verrà restituito da una chiamata successiva a WebSocketGetAction.

Valore restituito

Tipo: HRESULT

Se la funzione ha esito positivo, restituisce S_OK.

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

Codice restituito	Descrizione
E_INVALID_PROTOCOL_OPERATION	Protocollo eseguito un'operazione non valida.

Commenti

Dopo che un'applicazione invia un buffer webSocket WEB_SOCKET_CLOSE_BUFFER_TYPE correttamente, può inviare solo frame di controllo.

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

WebSocketAbortHandle

WebSocketCompleteAction

WebSocketGetAction

WebSocketReceive

Condividi tramite