GET_ENV_VALUE

有效对象

提取和复制

说明

使用 GET_ENV_VALUE 函数可返回有关 Oracle GoldenGate 环境的信息。提供的信息与 @GETENV 列转换函数的信息相同，并且使用相同的输入值进行指定。有关有效信息类型、环境变量和返回值的更多信息，请参见 "@GETENV "。

如果使用 SET_SESSION_CHARSET 将用户出口的字符会话设置为 ucharset.h 文件的 ULIB_CS_DEFAULT 中定义的操作系统默认字符集以外的值，则将在会话字符集中解释用户出口和进程之间交换的字符数据。

语法

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

缓冲区

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;

输入

<information_type>

要返回的信息类型，例如 'GGENVIRONMENT ’或 'GGHEADER ’。信息类型必须用双引号提供。有关信息类型和后续详细说明的列表，请参见 "@GETENV "。

<env_value_name>

需要从信息类型获取的环境值。必须在双引号内提供环境值。有关有效值，请参见 "@GETENV "。例如，如果使用 'GGENVIRONMENT 的信息类型，则有效的环境值为 'GROUPNAME”。

<max_return_length>

此数据缓冲区的最大长度。

输出

<return_value>

提供的环境值的有效返回值。

<actual_length>

此缓冲区中数据的实际长度。

<value_truncated>

指示值是否被截断的标志（0 或 1）。如果值长度加上空终止符超过最大缓冲区长度，则会发生截断。

返回值

EXIT_FN_RET_OK
EXIT_FN_RET_ENV_NOT_FOUND
EXIT_FN_RET_INVALID_PARAM