HCWebSocketGetHeader

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.lib Supported platforms: Windows, XBOX One family consoles and XBOX Series consoles

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Additional pages

Reference

Syntax

Parameters

Return value

Requirements

See also

​Syntax

​Parameters

​Return value

​Requirements

​See also

Syntax

Parameters

Return value

Requirements

See also