GET_USER_TOKEN_VALUE

有效对象

提取和复制

说明

使用 GET_USER_TOKEN_VALUE 函数从线索记录中获取用户标记的值。不对标记值执行字符集转换。

语法

#include "usrdecs.h"

缓冲区

typedef struct
{
char *token_name;
char *token_value;
long max_length;
long actual_length;
short value_truncated;
} token_value_def;

输入

<token_name>

指向表示令牌名称的缓冲区的指针。假定标记名称编码为操作系统默认字符集，该字符集承载配置了标记的提取 TABLE 语句。用户出口准备使用 SET_SESSION_CHARSET 指定的字符集中的标记名称，但在检索匹配的标记值之前将其转换回操作系统字符集。

<max_length>

分配的 token_name 缓冲区的最大长度，用于接受任何生成的令牌值。这以 NULL 终止字符串的形式返回。

输出

<token_value>

指向缓冲区的指针，表示令牌的返回值（如果有）。标记值将按原样传递回用户出口，而不进行任何字符集转换。

<actual_length>

返回的标记值的实际长度。如果找到标记并且不存在值，则返回值 0。

<value_truncated>

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

返回值

EXIT_FN_RET_INVALID_PARAM
EXIT_FN_RET_INVALID_CONTEXT
EXIT_FN_RET_TOKEN_NOT_FOUND
EXIT_FN_RET_OK