Die Funktion kcHttpGetHeaderByIndex liefert den Namen und Wert des HTTP-Header-Feldes für den angegebenen Index zurück.
Die Funktion kann im Teilprogramm und im HTTP-Exit-Programm aufgerufen werden.
Im Teilprogramm darf die Funktion nur im ersten Teilprogrammlauf eines Vorgangs aufgerufen werden.
kc_http_retcode kcHttpGetHeaderByIndex( int headerIndex,
char * headerName,
int * headerNameLth,
char * headerValue,
int * headerValueLth
);
Diese Funktion hat folgende Funktionsparameter:
| >> | headerIndex | Index des Header-Feldes, das gelesen werden soll. |
| << | headerName | Adresse des Puffers, in dem der Name des HTTP-Header-Feldes zurückgegeben wird. Der Puffer muss mindestens headerNameLth Bytes lang sein. |
| <> | headerNameLth | Adresse einer Variablen, in der beim Aufruf die Länge des Puffers für den Namen des HTTP-Header-Feldes übergeben und die tatsächliche Länge des Namens zurückgegeben wird. |
| << | headerValue | Adresse des Puffers, in dem der Wert des HTTP-Header-Feldes zurückgegeben wird. Der Puffer muss mindestens headerValueLth Bytes lang sein. |
| <> | headerValueLth | Adresse einer Variablen, in der beim Aufruf die Länge des Puffers für den Wert des HTTP-Header-Feldes übergeben und die tatsächliche Länge des Werts 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 vor dem KDCS-Aufruf INIT oder nicht im ersten Teilprogrammlauf eines Vorgangs oder außerhalb eines HTTP-Exit-Programms aufgerufen.
KC_HTTP_NO_HTTP_CLIENT
Der Vorgang wurde nicht von einem HTTP-Client gestartet.
KC_HTTP_INVALID_INDEX
Der angegebene Index headerIndex ist ungültig (kleiner oder gleich 0 oder größer als die Anzahl der im HTTP-Request enthaltenen HTTP-Header-Felder).
KC_HTTP_PARAM_VALUE_NULL
Die Adresse des Puffers für den Header-Namen headerName oder die Adresse der Länge des Header-Namens headerNameLth oder die Adresse des Puffers für den Header-Wert headerValue oder die Adresse der Länge des Header-Werts headerValueLth ist NULL.
KC_HTTP_INVALID_LENGTH
Der Wert der Länge des Header-Namens headerNameLth oder der Wert der Länge des Header-Werts headerValueLth ist kleiner oder gleich 0.
KC_HTTP_RESULT_TRUNCATED
Die Länge des Puffers für den Header-Namen und/oder Header-Wert ist kleiner als die tatsächliche Länge des Namens und/oder Werts. Die Zeichenfolgen werden verkürzt und die tatsächlichen Längen werden zurückgegeben.