GET_ENV_VALUE

Válido para

Extraer y Replicat

Descripción

Utilice la función GET_ENV_VALUE para devolver información sobre el entorno de Oracle GoldenGate. La información que se proporciona es la misma que la de la función de conversión de columna @GETENV y se especifica mediante los mismos valores de entrada. Para obtener más información sobre los tipos de información válidos, las variables de entorno y los valores de retorno, consulte "@GETENV".

Si la sesión de caracteres de la salida de usuario se define con SET_SESSION_CHARSET en un valor distinto del juego de caracteres por defecto del sistema operativo, como se define en ULIB_CS_DEFAULT en el archivo ucharset.h, los datos de caracteres que se intercambian entre la salida de usuario y el proceso se interpretan en el juego de caracteres de la sesión.

Sintaxis

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

Buffer

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;

Entrada

<information_type>

Tipo de información que se va a devolver, por ejemplo, 'GGENVIRONMENT' o 'GGHEADER'. El tipo de información se debe proporcionar entre comillas dobles. Para obtener una lista de tipos de información y descripciones detalladas posteriores, consulte "@GETENV".

<env_value_name>

Valor de entorno que se desea del tipo de información. El valor de entorno se debe proporcionar entre comillas dobles. Para conocer los valores válidos, consulte "@GETENV". Por ejemplo, si se utiliza el tipo de información 'GGENVIRONMENT, un valor de entorno válido sería 'GROUPNAME'.

<max_return_length>

Longitud máxima del buffer para estos datos.

Salida

<return_value>

Valor de retorno válido para el valor de entorno proporcionado.

<actual_length>

Longitud real de los datos en este buffer.

<value_truncated>

Indicador (0 o 1) para indicar si el valor se ha truncado o no. El truncamiento se produce si la longitud del valor más el terminador nulo supera la longitud máxima del buffer.

Valores devueltos

EXIT_FN_RET_OK
EXIT_FN_RET_ENV_NOT_FOUND
EXIT_FN_RET_INVALID_PARAM