Funktion kcHttpPutHeader

Mit der Funktion kcHttpPutHeader kann der Name und Wert eines HTTP-Header-Feldes für die HTTP Response übergeben werden. 
Die Länge des Header-Namens und die Länge des Header-Werts sind auf jeweils 256 Bytes beschränkt.  Die Anzahl der Header-Felder für eine HTTP-Response ist auf 100 beschränkt.  Die Gesamtlänge der Header einschließlich der Steuerzeichen (CLRF) ist auf 7000 Bytes beschränkt.
Der Header-Name kann in beliebiger Groß-/Kleinschreibung übergeben werden und wird so gesendet, wie er übergeben wurde. Es wird nicht erkannt, wenn der gleiche Header mehrfach übergeben wird. Die Werte werden daher nicht zusammengefasst, sondern alle Header werden einzeln gesendet.

Einige HTTP-Header-Felder werden immer von openUTM gesetzt und dürfen nicht vom Anwendungsprogramm übergeben werden. Andere HTTP-Header-Felder werden von openUTM nur dann gesetzt, wenn sie nicht vom Anwendungsprogramm übergeben werden.
Details finden Sie im Kapitel „Versorgung von HTTP-Headern".

Die Funktion kann im Teilprogramm und im HTTP-Exit-Programm aufgerufen werden. Im HTTP-Exit-Programm darf die Funktion nur beim Bearbeiten der Ausgabenachricht aufgerufen werden.

Wenn die Funktion im Teilprogrammlauf aufgerufen wird, so muss im selben Teilprogrammlauf mit MPUT eine Ausgabenachricht an den HTTP-Client bereitgestellt und der Vorgang beendet werden, ansonsten geht die übergebene Header-Information verloren.

Funktionsdeklaration kcHttpPutHeader

kc_http_retcode kcHttpPutHeader( char *  headerName,
                                 char *  headerValue
                               );

Diese Funktion hat folgende Funktionsparameter:

>>	headerName	Adresse des Namens des HTTP-Header-Feldes für die HTTP Response.
>>	headerValue	Adresse des Werts des HTTP-Header-Feldes für die HTTP Response.

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 vor dem KDCS-Aufruf INIT des Teilprogramms oder außerhalb eines HTTP-Exit-Programms aufgerufen.

KC_HTTP_NO_HTTP_CLIENT

Der Vorgang wurde nicht von einem HTTP-Client aufgerufen.

KC_HTTP_HEADER_NAME_NULL_OR_EMPTY

Die Adresse des Header-Namens headerName ist NULL oder der Name ist leer.

KC_HTTP_HEADER_VALUE_NULL_OR_EMPTY

Die Adresse des Header-Werts headerValue ist NULL oder der Wert ist leer.

KC_HTTP_HEADER_NAME_TOO_LONG

Der Name des angegebenen Header-Feldes ist zu lang.

KC_HTTP_HEADER_VALUE_TOO_LONG

Der Wert des angegebenen Header-Feldes ist zu lang.

KC_HTTP_HEADER_NOT_ALLOWED

Der angegebene Header-Name darf nicht gesetzt werden.

KC_HTTP_MAX_HEADER_COUNT

Die maximale Anzahl der Header wurde überschritten.

KC_HTTP_MAX_HEADER_TOTAL_LENGTH

Die maximale Gesamtlänge der Header einschließlich Steuerzeichen wurde überschritten.

KC_HTTP_HEADER_NAME_NOT_PRINTABLE

Der Name des angegebenen Header-Feldes enthält ein nicht abdruckbares Zeichen.

KC_HTTP_HEADER_VALUE_NOT_PRINTABLE

Der Wert des angegebenen Header-Feldes enthält ein nicht abdruckbares Zeichen.