GET_USER_TOKEN_VALUE

Gültig für

Extrakt und Replicat

Beschreibung

Verwenden Sie die Funktion GET_USER_TOKEN_VALUE, um den Wert eines Benutzertokens aus einem Traildatensatz abzurufen. Für den Tokenwert wird keine Zeichensatzkonvertierung ausgeführt.

Syntax

#include "usrdecs.h"

Puffer

typedef struct
{
char *token_name;
char *token_value;
long max_length;
long actual_length;
short value_truncated;
} token_value_def;

Eingabe

<token_name>

Ein Zeiger auf einen Puffer, der den Namen eines Tokens darstellt. Es wird davon ausgegangen, dass der Tokenname im Standardzeichensatz des Betriebssystems codiert ist, das die Extract TABLE-Anweisung hostet, in der das Token konfiguriert ist. Der User Exit bereitet den Tokennamen im Zeichensatz vor, der mit SET_SESSION_CHARSET angegeben ist, konvertiert ihn jedoch zurück in den Betriebssystemzeichensatz, bevor der übereinstimmende Tokenwert abgerufen wird.

<max_length>

Die maximale Länge des zugewiesenen token_name-Puffers, um einen resultierenden Tokenwert zu akzeptieren. Dies wird als beendete NULL-Zeichenfolge zurückgegeben.

Ausgabe

<token_value>

Ein Zeiger auf einen Puffer, der den Rückgabewert (falls vorhanden) eines Tokens darstellt. Der Tokenwert wird unverändert ohne Zeichensatzkonvertierung an den User Exit übergeben.

<actual_length>

Die tatsächliche Länge des zurückgegebenen Tokenwerts. Ein Wert von 0 wird zurückgegeben, wenn das Token gefunden wurde und kein Wert vorhanden ist.

<value_truncated>

Ein Flag von 0 oder 1, das angibt, ob der Tokenwert abgeschnitten wurde. Eine Abkürzung tritt auf, wenn die Länge des Tabellennamens plus des Null-Terminators die maximale Pufferlänge überschreitet.

Rückgabewerte

EXIT_FN_RET_INVALID_PARAM
EXIT_FN_RET_INVALID_CONTEXT
EXIT_FN_RET_TOKEN_NOT_FOUND
EXIT_FN_RET_OK