GET_ENV_VALUE

有效對象

擷取與 Replicat

說明

使用 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