Die Funktion kcHttpGetHeaderByName liefert den Wert des über den Namen spezifizierten HTTP-Header-Feldes zurück. Das Header-Feld Authorization kann nicht gelesen werden.
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 kcHttpGetHeaderByName( char * headerName,
char * headerValue,
int * headerValueLth
);
Diese Funktion hat folgende Funktionsparameter:
| >> | headerName | Name des HTTP-Header-Feldes, dessen Wert gelesen werden soll. |
| << | 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_HEADER_NAME_NULL_OR_EMPTY
Die Adresse des Header-Namens headerName ist NULL oder der Name ist leer.
KC_HTTP_PARAM_VALUE_NULL
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-Werts headerValueLth ist kleiner oder gleich 0.
KC_HTTP_HEADER_NOT_FOUND
Es existiert kein HTTP Header mit dem in headerName angegebenen Namen.
KC_HTTP_RESULT_TRUNCATED
Die Länge des Puffers für den Header-Wert ist kleiner als die tatsächliche Länge des Werts. Der Header-Wert wird verkürzt und die tatsächliche Länge wird zurückgegeben.