GET_ENV_VALUE

Durée de validité

Extraction et réplication

Description

Utilisez la fonction GET_ENV_VALUE pour renvoyer des informations sur l'environnement Oracle GoldenGate. Les informations fournies sont identiques à celles de la fonction de conversion de colonne @GETENV. Elles sont indiquées en utilisant les mêmes valeurs d'entrée. Pour plus d'informations sur les types d'informations valides, les variables d'environnement et les valeurs renvoyées, reportez-vous à "@GETENV".

Si la session de caractères de l'exit utilisateur est définie avec SET_SESSION_CHARSET sur une valeur autre que le jeu de caractères par défaut du système d'exploitation, tel que défini dans ULIB_CS_DEFAULT dans le fichier ucharset.h, les données de caractères échangées entre l'exit utilisateur et le processus sont interprétées dans le jeu de caractères de session.

Syntaxe

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

Tampon

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;

Entrée

<information_type>

Type d'informations à renvoyer, par exemple 'GGENVIRONMENT' ou 'GGHEADER'. Le type d'informations doit être indiqué entre guillemets doubles. Pour obtenir la liste des types d'informations et les descriptions détaillées suivantes, reportez-vous à la section "@GETENV".

<env_value_name>

Valeur d'environnement recherchée à partir du type d'informations. La valeur d'environnement doit être indiquée entre guillemets doubles. Pour connaître la valeur valide, reportez-vous à "@GETENV". Par exemple, si vous utilisez le type d'informations 'GGENVIRONMENT, une valeur d'environnement valide est 'GROUPNAME'.

<max_return_length>

Longueur maximale des données de tampon.

Sortie

<return_value>

Valeur de retour valide pour la valeur d'environnement fournie.

<actual_length>

Longueur réelle des données dans ce tampon.

<value_truncated>

Indicateur (0 ou 1) indiquant si la valeur a été tronquée. La troncature se produit si la longueur de la valeur plus la terminaison NULL dépasse la longueur maximale du tampon.

Valeurs retournées

EXIT_FN_RET_OK
EXIT_FN_RET_ENV_NOT_FOUND
EXIT_FN_RET_INVALID_PARAM