HTTPClient_AddHeader

Add a header to the request headers stored in HTTPRequestHeaders_t.pBuffer.

HTTPStatus_t HTTPClient_AddHeader( HTTPRequestHeaders_t * pRequestHeaders,
                                   const char * pField,
                                   size_t fieldLen,
                                   const char * pValue,
                                   size_t valueLen );

Upon return, pRequestHeaders->headersLen will be updated with the number of bytes written.

Headers are written in the following format:

<field>: <value>\r\n\r\n

The trailing \r\n that denotes the end of the header lines is overwritten, if it already exists in the buffer.

Note

This function validates only that \r, \n, and : are not present in pValue or pField. : is allowed in pValue.

Parameters

[in]	pRequestHeaders	Request header buffer information.
[in]	pField	The header field name to write. The data should be ISO 8859-1 (Latin-1) encoded per the HTTP standard, but the API does not perform the character set validation.
[in]	fieldLen	The byte length of the header field name.
[in]	pValue	The header value to write. The data should be ISO 8859-1 (Latin-1) encoded per the HTTP standard, but the API does not perform the character set validation.
[in]	valueLen	The byte length of the header field value.

Returns

One of the following:

• HTTPSuccess (If successful.)
• HTTPInvalidParameter (If any provided parameters or their members are invalid.)
• HTTPInsufficientMemory (If application-provided buffer is not large enough to hold headers.)
• HTTPSecurityAlertInvalidCharacter (If an invalid character was found in pField or pValue.)

Example

HTTPStatus_t httpLibraryStatus = HTTPSuccess;
// Assume that requestHeaders has already been initialized with
// HTTPClient_InitializeRequestHeaders().
HTTPRequestHeaders_t requestHeaders;
 
httpLibraryStatus = HTTPClient_AddHeader( &requestHeaders,
                                          "Request-Header-Field",
                                          sizeof( "Request-Header-Field" ) - 1U,
                                          "Request-Header-Value",
                                          sizeof("Request-Header-Value") - 1U );