HCHttpCallRequestGetHeaderAtIndex

Article
06/22/2023

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

Syntax

HRESULT HCHttpCallRequestGetHeaderAtIndex(  
         HCCallHandle call,  
         uint32_t headerIndex,  
         const char** headerName,  
         const char** headerValue  
)

Parameters

call _In_
Type: HCCallHandle

The handle of the HTTP call.

headerIndex _In_
Type: uint32_t

Specific zero based index of the request header.

headerName _Out_
Type: char**

UTF-8 encoded request header name for the HTTP call.

headerValue _Out_
Type: char**

UTF-8 encoded request 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 HCHttpCallRequestGetNumHeaders() to know how many request headers there are in the HTTP call.

Requirements

Header: httpProvider.h

Library: libHttpClient.141.GSDK.C.lib

Share via