GET_ENV_VALUE

適用対象

Extractおよび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が有効な環境値の1つです。
max_return_length: このデータのバッファの最大長。

出力

return_value: この環境値に対して有効な戻り値。
actual_length: このバッファのデータの実際の長さ。
value_truncated: 値が切り捨てられたかどうかを示すフラグ(0または1)。切捨ては、値とNULL終了文字を足した長さが、最大バッファ長を超えるときに行われます。

返される値

EXIT_FN_RET_OK
EXIT_FN_RET_ENV_NOT_FOUND
EXIT_FN_RET_INVALID_PARAM