Mit der Funktion kcHttpPutRspMsgBody
kann der Message Body für die HTTP-Response bereitgestellt werden.
Der Message Body kann sukzessive mit mehreren Aufrufen der Funktion aufgebaut werden, ohne dass sich der Aufrufer selbst um die Anforderung und Verwaltung des benötigten Speicherbereichs kümmern muss.
Diese Funktion darf nur von einem HTTP-Exit-Programm beim Bearbeiten der Ausgabenachricht aufgerufen werden.
kc_http_retcode kcHttpPutRspMsgBody( void * rspMessageBody, int rspMessageBodyLth, void ** totalRspMessageBody, int * totalRspMessageBodyLth );
Diese Funktion hat folgende Parameter:
>> | rspMessageBody | Adresse des übergebenen (Teils des) Message Body. |
>> | rspMessageBodyLth | Länge des übergebenen (Teils des) Message Body. |
<< | totalRspMessageBody | Adresse einer Variablen, in der die Adresse des bisher aufgebauten gesamten Message Body zurückgegeben wird. |
<< | totalRspMessageBodyLth | Adresse einer Variablen, in der die Länge des bisher aufgebauten gesamten Message Body zurückgegeben wird. |
Der zurückgelieferte Funktionswert hat folgende Bedeutung:
KC_HTTP_OK
Die Funktion wurde erfolgreich ausgeführt.
KC_HTTP_FUNCTION_CALL_NOT_ALLOWED
Die Funktion wurde nicht von einem HTTP-Exit Programm beim Bearbeiten der Ausgabenachricht aufgerufen.
KC_HTTP_PARAM_VALUE_NULL
Die Adresse der Nachricht rspMessageBody
, die Adresse der Variablen totalRspMessageBody
oder die Adresse der Variablen totalRspMessageBodyLth
ist NULL.
KC_HTTP_INVALID_LENGTH
Der Wert des Parameters rspMessageBodyLth
ist kleiner oder gleich 0.
KC_HTTP_MEMORY_INSUFFICIENT
Es konnte kein weiterer Speicher für den Message Body der HTTP Response allokiert werden.