An HTTP exit program can use the function kcHttpPutMgetMsg to create a message for the program unit, which can be read with MGET.
The message 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. How to structure this message into message segments that can be read in the program unit with MGET NT is described in chapter "Event exit HTTP".
This function may only called by an HTTP exit program when processing the input message.
kc_http_retcode kcHttpPutMgetMsg( void * mgetMessage,
int mgetMessageLth,
void ** totalMgetMessage,
int * totalMgetMessageLth
);
This function has following function parameter:
| >> | mgetMessage | The pointer to the passed (part of) message. |
| >> | mgetMessageLth | The length of the passed (part of) message. |
| << | totalMgetMessage | The pointer to a variable in which the pointer to the complete message built so far is returned. |
| << | totalMgetMessageLth | The pointer to a variable in which the length of the complete message 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 input message.
KC_HTTP_PARAM_VALUE_NULL
The pointer to the passed message mgetMessage, the pointer to the variable totalMgetMessage or the pointer to variable totalMgetMessageLth is NULL.
KC_HTTP_INVALID_LENGTH
The value of parameter mgetMessageLth is lower or equal 0.
KC_HTTP_MEMORY_INSUFFICIENT
No further memory could be allocated for the complete message.