GET_OBJECT_NAME

有效对象

提取和复制

说明

使用 GET_OBJECT_NAME 函数检索与正在处理的记录关联的源或目标对象的全限定名称。此函数是 DML 或 DDL 操作中的有效表和其他对象。

要仅返回对象名称的一部分，请参见以下内容：

GET_OBJECT_NAME_ONLY GET_SCHEMA_NAME_ONLY GET_CATALOG_NAME_ONLY

数据库对象名称的返回方式与托管数据库中定义的名称完全相同，包括字母大小写。

语法

#include "usrdecs.h"
short result_code;
env_value_def env_value;
ERCALLBACK (GET_OBJECT_NAME, &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>

分配的缓冲区接受对象名称的最大长度。这以 NULL 终止的字符串形式返回。

<source_or_target>

以下项之一，指示是返回源对象还是目标对象名称。

EXIT_FN_SOURCE_VAL
EXIT_FN_TARGET_VAL

输出

<buffer>

完全限定且以 null 结尾的对象名称，例如 schema.object 或 catalog.schema.object，具体取决于数据库平台。

如果使用 SET_SESSION_CHARSET 将用户出口的字符会话设置为 ucharset.h 文件的 ULIB_CS_DEFAULT 中定义的操作系统默认字符集以外的值，则会在会话字符集中解释对象名称。

实际时长

返回的对象名称的字符串长度。实际长度不包括 NULL 终止符。如果对象是表，则实际长度为 0。

<value_truncated>

指示值是否被截断的标志（0 或 1）。如果对象名称的长度加上空终止符超过了最大缓冲区长度，则会发生截断。

返回值

EXIT_FN_RET_INVALID_COLUMN
EXIT_FN_RET_INVALID_CONTEXT
EXIT_FN_RET_INVALID_PARAM
EXIT_FN_RET_OK