GET_USER_TOKEN_VALUE

Válido Para

Extract e Replicat

Descrição

Use a função GET_USER_TOKEN_VALUE para obter o valor de um token de usuário de um registro de trilha. Nenhuma conversão de conjunto de caracteres é executada no valor do token.

Sintaxe

#include "usrdecs.h"

Buffer

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

Entrada

<token_name>

Um ponteiro para um buffer que representa o nome de um token. Supõe-se que o nome do token esteja codificado no conjunto de caracteres padrão do sistema operacional que hospeda a instrução Extract TABLE na qual o token está configurado. A saída do usuário prepara o nome do token no conjunto de caracteres especificado com SET_SESSION_CHARSET, mas o converte de volta para o conjunto de caracteres do sistema operacional antes de recuperar o valor do token correspondente.

<max_length>

O tamanho máximo do buffer token_name alocado para aceitar qualquer valor de token resultante. Isso é retornado como uma string encerrada NULL.

Saída

<token_value>

Um ponteiro para um buffer representando o valor de retorno (se houver) de um token. O valor do token é passado de volta para a saída do usuário como está, sem qualquer conversão de conjunto de caracteres.

<actual_length>

O tamanho real do valor do token retornado. Um valor 0 será retornado se o token for encontrado e não houver valor presente.

<value_truncated>

Um flag de 0 ou 1 que indica se o valor do token foi truncado ou não. Truncação ocorre se o tamanho do nome da tabela mais o terminador nulo exceder o tamanho máximo do buffer.

Valores de Retorno

EXIT_FN_RET_INVALID_PARAM
EXIT_FN_RET_INVALID_CONTEXT
EXIT_FN_RET_TOKEN_NOT_FOUND
EXIT_FN_RET_OK