XblHttpCallGetHeaderAtIndex

Gets the response headers at specific zero based index in the HTTP call.

Syntax

HRESULT XblHttpCallGetHeaderAtIndex(  
         XblHttpCallHandle call,  
         uint32_t headerIndex,  
         const char** headerName,  
         const char** headerValue  
)  

Parameters

call   _In_
Type: XblHttpCallHandle The handle of the HTTP call. headerIndex   _In_
Type: uint32_t Specific zero based index of the response header. headerName   _Out_
Type: char** UTF-8 encoded response header name for the HTTP call. The memory for the returned string pointer remains valid for the life of the XblHttpCallHandle object until XblHttpCallCloseHandle() is called on it. headerValue   _Out_
Type: char** UTF-8 encoded response header value for the HTTP call. The memory for the returned string pointer remains valid for the life of the XblHttpCallHandle object until XblHttpCallCloseHandle() is called on it.

Return value

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

Remarks

This can only be called after calling XblHttpCallPerformAsync when the HTTP task is completed. Use XblHttpCallGetNumHeaders to know how many response headers there are in the HTTP call.

Requirements

Header: http_call_c.h Library: Microsoft.Xbox.Services.142.C.lib or Microsoft.Xbox.Services.143.C.lib

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