GET_COLUMN_NAME_FROM_INDEX

有效对象

提取和复制

说明

使用 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 结尾的列名。

实际时长

返回的列名的字符串长度。实际长度不包括 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