GET_ENV_VALUE

Gültig für

Extrakt und Replicat

Beschreibung

Verwenden Sie die Funktion GET_ENV_VALUE, um Informationen zur Oracle GoldenGate-Umgebung zurückzugeben. Die bereitgestellten Informationen entsprechen denen der Spaltenkonvertierungsfunktion @GETENV und werden mit denselben Eingabewerten angegeben. Weitere Informationen zu den gültigen Informationstypen, Umgebungsvariablen und Rückgabewerten finden Sie unter "@GETENV".

Wenn die Zeichensession des User Exit mit SET_SESSION_CHARSET auf einen anderen Wert als den Standardzeichensatz des Betriebssystems gesetzt wird, wie in ULIB_CS_DEFAULT in der Datei ucharset.h definiert, werden die Zeichendaten, die zwischen dem User Exit und dem Prozess ausgetauscht werden, im Sessionzeichensatz interpretiert.

Syntax

#include "usrdecs.h"
short result_code;
getenv_value_def env_ptr;
ERCALLBACK (GET_ENV_VALUE, &env_ptr, &result_code);

Puffer

typedef struct
{
char *information_type;
char *env_value_name;
char *return_value;
long max_return_length;
long actual_length;
short value_truncated;
} getenv_value_def;

Eingabe

<information_type>

Der Informationstyp, der zurückgegeben werden soll, z.B. 'GGENVIRONMENT' oder 'GGHEADER'. Der Informationstyp muss in doppelte Anführungszeichen gesetzt werden. Eine Liste der Informationstypen und nachfolgende detaillierte Beschreibungen finden Sie unter "@GETENV".

<env_value_name>

Der Umgebungswert, der vom Informationstyp gewünscht wird. Der Umgebungswert muss in doppelte Anführungszeichen gesetzt werden. Gültige Werte finden Sie unter "@GETENV". Beispiel: Wenn Sie den Informationstyp 'GGENVIRONMENT verwenden, wäre ein gültiger Umgebungswert 'GROUPNAME'.

<max_return_length>

Die maximale Länge des Pufferns für diese Daten.

Ausgabe

<return_value>

Ein gültiger Rückgabewert für den angegebenen Umgebungswert.

<actual_length>

Die tatsächliche Länge der Daten in diesem Puffer.

<value_truncated>

Ein Flag (0 oder 1), das angibt, ob der Wert abgeschnitten wurde. Eine Abkürzung tritt auf, wenn die Länge des Wertes plus Null-Beendigungszeichen die maximale Pufferlänge überschreitet.

Rückgabewerte

EXIT_FN_RET_OK
EXIT_FN_RET_ENV_NOT_FOUND
EXIT_FN_RET_INVALID_PARAM