GET_USER_TOKEN_VALUE

有效對象

擷取與 Replicat

說明

使用 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>

代表記號名稱的緩衝區指標。假設記號名稱是使用代管設定記號之 Extract 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