HTTPc_ReqSetParam

Setups a parameter related to the given HTTPc Request Object.

Files

http-c.h/http-c.c

Prototype

          void  HTTPc_ConnSetParam (HTTPc_REQ_OBJ     *p_req_obj,
                                    HTTPc_PARAM_TYPE   type,
                                    void              *p_param
                                    HTTPc_ERR         *p_err);

Arguments

p_req_obj

Pointer to the HTTPc Request Object on which to setup the parameter.

type

Parameter type:

HTTPc_PARAM_TYPE_REQ_QUERY_STR_TBL
HTTPc_PARAM_TYPE_REQ_QUERY_STR_HOOK
HTTPc_PARAM_TYPE_REQ_HDR_TBL
HTTPc_PARAM_TYPE_REQ_HDR_HOOK
HTTPc_PARAM_TYPE_REQ_FORM_TBL
HTTPc_PARAM_TYPE_REQ_BODY_CONTENT_TYPE
HTTPc_PARAM_TYPE_REQ_BODY_CONTENT_LEN
HTTPc_PARAM_TYPE_REQ_BODY_DATA_PTR
HTTPc_PARAM_TYPE_REQ_CHUNK_BODY_HOOK
HTTPc_PARAM_TYPE_RESP_HDR_HOOK
HTTPc_PARAM_TYPE_RESP_BODY_HOOK
HTTPc_PARAM_TYPE_TRANS_COMPLETE_CALLBACK
HTTPc_PARAM_TYPE_TRANS_ERR_CALLBACK

p_param

Pointer to parameter to setup.

p_err

Pointer to variable that will receive the return error code from this function:

HTTPc_ERR_NONE
HTTPc_ERR_NULL_PTR
HTTPc_ERR_INIT_NOT_COMPLETED
HTTPc_ERR_CONN_IS_USED
HTTPc_ERR_PARAM_INVALID
HTTPc_ERR_FEATURE_DIS

Returned Values

None.

Required Configuration

None.

Notes / Warnings

• This function MUST be called after the µC/HTTP-client suite initialization has been completed.
• The parameter's value MUST stay valid and not be modified until the HTTP Transaction is completed.