HCWebSocketGetHeaderAtIndex

Gets the headers at specific zero based index in the WebSocket.

Syntax

HRESULT HCWebSocketGetHeaderAtIndex(  
         HCWebsocketHandle websocket,  
         uint32_t headerIndex,  
         const char** headerName,  
         const char** headerValue  
)  

Parameters

websocket   _In_
Type: HCWebsocketHandle The handle of the WebSocket. headerIndex   _In_
Type: uint32_t Specific zero based index of the header. headerName   _Out_
Type: char** UTF-8 encoded header name for the HTTP call. headerValue   _Out_
Type: char** UTF-8 encoded header value for the HTTP call.

Return value

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

Remarks

Use HCHttpCallGetNumHeaders() to know how many headers there are in the HTTP call.

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

Remarks

Requirements

See also

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

Syntax

Parameters

Return value

Remarks

Requirements

See also