GET_COLUMN_NAME_FROM_INDEX

有效對象

擷取與 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>

接受傳回之資料欄名稱的緩衝區指標。資料欄名稱為空值終止。

<max_length>

您配置的 buffer 接受結果資料欄名稱的長度上限。以 NULL 終止字串傳回此字串。

<index>

要傳回之資料欄名稱的資料欄索引。

<source_or_target>

下列其中一項，指示是否要使用來源或目標表格來查詢資料欄資訊。

EXIT_FN_SOURCE_VAL
EXIT_FN_TARGET_VAL

輸出

<buffer>

空值終止的資料欄名稱。

實際長

傳回之資料欄名稱的字串長度。實際長度不包含空值終止字元。

<value_truncated>

指示值是否被截斷的旗標 (0 或 1)。如果資料欄名稱加上空值終止字元的長度超過緩衝區長度上限，就會發生截斷。

傳回值

EXIT_FN_RET_INVALID_COLUMN
EXIT_FN_RET_INVALID_CONTEXT
EXIT_FN_RET_INVALID_PARAM
EXIT_FN_RET_OK