Share via

HCWebSocketGetHeader

  • Article

Get a header for the WebSocket.

Syntax

HRESULT HCWebSocketGetHeader(  
         HCWebsocketHandle websocket,  
         const char* headerName,  
         const char** headerValue  
)

Parameters

websocket   _In_
Type: HCWebsocketHandle

The handle of the WebSocket.

headerName   _In_z_
Type: char*

UTF-8 encoded header name for the WebSocket.

headerValue   _Out_
Type: char**

UTF-8 encoded header value for the WebSocket.

Return value

Type: HRESULT

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

Requirements

Header: httpProvider.h

Library: libHttpClient.141.GSDK.C.lib

See also

httpProvider