HCWebSocketSendBinaryMessageAsync

  • Article

Send binary message to the WebSocket.

Syntax

HRESULT HCWebSocketSendBinaryMessageAsync(  
         HCWebsocketHandle websocket,  
         const uint8_t* payloadBytes,  
         uint32_t payloadSize,  
         XAsyncBlock* asyncBlock  
)

Parameters

websocket   _In_
Type: HCWebsocketHandle

Handle to the WebSocket.

payloadBytes   _In_reads_bytes_(payloadSize)
Type: uint8_t*

Binary data to send in byte buffer.

payloadSize   _In_
Type: uint32_t

Size of byte buffer.

asyncBlock   _Inout_
Type: XAsyncBlock*

The AsyncBlock that defines the async operation.

Return value

Type: HRESULT

Result code for this API operation. Possible values are S_OK, E_INVALIDARG, or E_FAIL.

Remarks

To get the result, first call HCGetWebSocketSendMessageResult inside the AsyncBlock callback or after the AsyncBlock is complete.

Requirements

Header: httpClient.h

Library: libHttpClient.141.GSDK.C.lib

See also

httpClient