GET_ENV_VALUE

Válido Para

Extract e Replicat

Descrição

Use a função GET_ENV_VALUE para retornar informações sobre o ambiente do Oracle GoldenGate. As informações fornecidas são as mesmas da função de conversão de coluna @GETENV e são especificadas usando os mesmos valores de entrada. Para obter mais informações sobre os tipos de informação válidos, variáveis de ambiente e valores de retorno, consulte "@GETENV".

Se a sessão de caracteres da saída do usuário for definida com SET_SESSION_CHARSET para um valor diferente do conjunto de caracteres padrão do sistema operacional, conforme definido em ULIB_CS_DEFAULT no arquivo ucharset.h, os dados de caracteres que são trocados entre a saída do usuário e o processo serão interpretados no conjunto de caracteres da sessão.

Sintaxe

#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>

O tipo de informação a ser retornado, por exemplo, 'GGENVIRONMENT' ou 'GGHEADER'. O tipo de informação deve ser fornecido entre aspas duplas. Para obter uma lista de tipos de informações e descrições detalhadas subsequentes, consulte "@GETENV".

<env_value_name>

O valor do ambiente desejado no tipo de informação. O valor do ambiente deve ser fornecido entre aspas duplas. Para obter valores válidos, consulte "@GETENV". Por exemplo, se o tipo de informação 'GGENVIRONMENT for usado, um valor de ambiente válido será 'GROUPNAME'.

<max_return_length>

O tamanho máximo do buffer para esses dados.

Saída

<return_value>

Um valor de retorno válido para o valor do ambiente fornecido.

<actual_length>

O tamanho real dos dados neste buffer.

<value_truncated>

Um flag (0 ou 1) para indicar se o valor foi truncado ou não. Truncação ocorre se o comprimento do valor mais o terminador nulo exceder o comprimento máximo do buffer.

Valores de Retorno

EXIT_FN_RET_OK
EXIT_FN_RET_ENV_NOT_FOUND
EXIT_FN_RET_INVALID_PARAM