You can use the function kcHttpPutRspMsgBody
to create the message body of the HTTP response.
The message body can be built up successively with several calls of the function, without the caller himself having to take care of the request and administration of the required memory.
This function may only called by an HTTP exit program when processing the output message.
kc_http_retcode kcHttpPutRspMsgBody( void * rspMessageBody, int rspMessageBodyLth, void ** totalRspMessageBody, int * totalRspMessageBodyLth );
This function has following function parameter:
>> | rspMessageBody | The pointer to the passed (part of) message body. |
>> | rspMessageBodyLth | The length of the passed (part of) message body. |
<< | totalRspMessageBody | The pointer to a variable in which the pointer to the complete message body built so far is returned. |
<< | totalRspMessageBodyLth | The pointer to a variable in which the length of the complete message body built so far is returned. |
Description of returned value of function call:
KC_HTTP_OK
The function has successfully terminated.
KC_HTTP_FUNCTION_CALL_NOT_ALLOWED
The function was not called by an HTTP exit program during processing the output message.
KC_HTTP_PARAM_VALUE_NULL
The pointer to the passed message rspMessageBody
, the pointer to the variable totalRspMessageBody
or the the pointer to variable totalRspMessageBodyLth
is NULL.
KC_HTTP_INVALID_LENGTH
The value of parameter rspMessageBodyLth
is lower or equal 0.
KC_HTTP_MEMORY_INSUFFICIENT
Memory allocation failed.