6.18 GET_COLUMN_NAME_FROM_INDEX

適用対象

ExtractおよびReplicat

説明

GET_COLUMN_NAME_FROM_INDEXファンクションでは、特定の列索引に関連付けられている列名を確認します。ユーザー・イグジットの文字セッションが、SET_SESSION_CHARSETを使用して、オペレーティング・システムのデフォルトのキャラクタ・セット以外の値に設定されている場合、ucharset.hファイルのULIB_CS_DEFAULTで定義されているように、ユーザー・イグジットとプロセス間で交換される文字データは、セッションのキャラクタ・セットで解釈されます。

データベース・オブジェクト名は、大/小文字の区別を含め、ホストしているデータベースで定義されているとおりに、正確に返されます。

構文

#include "usrdecs.h"
short result_code;
env_value_def env_value;
ERCALLBACK (GET_COLUMN_NAME_FROM_INDEX, &env_value, &result_code);

バッファ

typedef struct
{
char *buffer;
long max_length;
long actual_length;
short value_truncated;
short index;
short source_or_target;
} env_value_def;

入力

buffer

返される列名を受け付けるバッファへのポインタ。列名はNULLで終了します。

max_length

結果の列名を受け付けるために割り当てたbufferの最大長。NULL終了文字列として返されます。

index

返される列名の列索引。

source_or_target

列名情報を参照するためにソース表とターゲット表のどちらを使用するかを示す次の一方。

EXIT_FN_SOURCE_VAL
EXIT_FN_TARGET_VAL

出力

buffer

NULLで終了している列名。

actual length

返される列名の文字列長。実際の長さにNULL終了文字は含まれません。

value_truncated

値が切り捨てられたかどうかを示すフラグ(0または1)。切捨ては、列名とNULL終了文字を足した長さが、最大バッファ長を超えるときに行われます。

返される値

EXIT_FN_RET_INVALID_COLUMN
EXIT_FN_RET_INVALID_CONTEXT
EXIT_FN_RET_INVALID_PARAM
EXIT_FN_RET_OK