GET_USER_TOKEN_VALUE

有効な対象

Extractおよび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)。切捨ては、表名とNULL終了文字を足した長さが、最大バッファ長を超えるときに行われます。

戻り値

EXIT_FN_RET_INVALID_PARAM
EXIT_FN_RET_INVALID_CONTEXT
EXIT_FN_RET_TOKEN_NOT_FOUND
EXIT_FN_RET_OK