GET_COLUMN_NAME_FROM_INDEX

Válido Para

Extract e Replicat

Descrição

Use a função GET_COLUMN_NAME_FROM_INDEX para determinar o nome da coluna associado a um índice de coluna especificado. Se a sessão de caracteres da saída do usuário for definida com SET_SESSION_CHARSET para um valor diferente do conjunto de caracteres padrão do sistema operacional, conforme definido em ULIB_CS_DEFAULT no arquivo ucharset.h, os dados de caracteres que são trocados entre a saída do usuário e o processo serão interpretados no conjunto de caracteres da sessão.

Os nomes de objeto de banco de dados são retornados exatamente como são definidos no banco de dados de hospedagem, incluindo a letra maiúscula.

Sintaxe

#include "usrdecs.h"
short result_code;
env_value_def env_value;
ERCALLBACK (GET_COLUMN_NAME_FROM_INDEX, &env_value, &result_code);

Buffer

typedef struct
{
char *buffer;
long max_length;
long actual_length;
short value_truncated;
short index;
short source_or_target;
} env_value_def;

Entrada

<buffer>

Um ponteiro para um buffer a fim de aceitar o nome da coluna retornada. O nome da coluna é nulo terminado.

<max_length>

O tamanho máximo do buffer alocado para aceitar o nome da coluna resultante. Isso é retornado como uma string encerrada NULL.

<index>

O índice de coluna do nome da coluna a ser retornada.

<source_or_target>

Uma das opções a seguir indica se a tabela de origem ou de destino deve ser usada para pesquisar informações da coluna.

EXIT_FN_SOURCE_VAL
EXIT_FN_TARGET_VAL

Saída

<buffer>

O nome da coluna terminado com valor nulo.

tamanho real

O tamanho da string do nome da coluna retornada. O tamanho real não inclui o terminador nulo.

<value_truncated>

Um flag (0 ou 1) para indicar se o valor foi truncado ou não. Ocorre truncamento se o tamanho do nome da coluna mais o terminador nulo exceder o tamanho máximo do buffer.

Valores de Retorno

EXIT_FN_RET_INVALID_COLUMN
EXIT_FN_RET_INVALID_CONTEXT
EXIT_FN_RET_INVALID_PARAM
EXIT_FN_RET_OK