Estrutura JET_RETRIEVECOLUMN

Aplica-se a: Windows | Windows Server

Estrutura JET_RETRIEVECOLUMN

A estrutura JET_RETRIEVECOLUMN contém parâmetros de entrada e saída para JetRetrieveColumns. Os campos na estrutura descrevem qual valor de coluna recuperar, como recuperá-lo e onde salvar resultados.

    typedef struct {
      JET_COLUMNID columnid;
      void* pvData;
      unsigned long cbData;
      unsigned long cbActual;
      JET_GRBIT grbit;
      unsigned long ibLongValue;
      unsigned long itagSequence;
      JET_COLUMNID columnidNextTagged;
      JET_ERR err;
    } JET_RETRIEVECOLUMN;

Membros

Columnid

O identificador de coluna para a coluna a ser recuperada.

pvData

Um ponteiro para começar a armazenar dados recuperados do valor da coluna.

cbData

O tamanho da alocação começando em pvData, em bytes. A operação recuperar coluna não armazenará mais dados em pvData do que cbData.

cbActual

O tamanho, em bytes, dos dados recuperados por uma operação de recuperação de coluna.

grbit

Um grupo de bits que contém as opções de recuperação de coluna, que incluem zero ou mais dos valores a seguir.

Valor	Significado
JET_bitRetrieveCopy	Recupera o valor modificado em vez do valor original. Se o valor não tiver sido modificado, o valor original será recuperado. Dessa forma, um valor que ainda não foi inserido ou atualizado pode ser recuperado quando um registro é inserido ou atualizado.
JET_bitRetrieveFromIndex	Recupera valores de coluna do índice sem acessar o registro, se possível. Dessa forma, o carregamento desnecessário de registros pode ser evitado quando os dados necessários estão disponíveis nas próprias entradas de índice. Nos casos em que o valor da coluna original não pode ser recuperado do índice, devido a transformações irreversíveis ou truncamento de dados, o registro será acessado e os dados recuperados normalmente. Essa é uma opção de desempenho e só deve ser especificada quando é provável que o valor da coluna possa ser recuperado do índice. Essa opção não deve ser especificada se o índice atual for o índice clusterizado, pois as entradas de índice para o índice clusterizado ou primário são os próprios registros. Esse bit não poderá ser definido se JET_bitRetrieveFromPrimaryBookmark também estiver definido.
JET_bitRetrieveFromPrimaryBookmark	Recupera valores de coluna do indicador de índice e pode ser diferente do valor do índice quando uma coluna aparece no índice primário e no índice atual. Essa opção não deve ser especificada se o índice atual for o índice clusterizado ou primário. Esse bit não poderá ser definido se JET_bitRetrieveFromIndex também estiver definido.
JET_bitRetrieveTag	Recupera o número de sequência de um valor de coluna de vários valores em pretinfo-itagSequence>. O campo itagSequence geralmente é usado como entrada para recuperar valores de coluna de vários valores de um registro. No entanto, ao recuperar valores de um índice, também é possível associar a entrada de índice a um número de sequência específico e recuperar esse número de sequência também. A recuperação do número de sequência pode ser uma operação dispendiosa e só deve ser feita se necessário.
JET_ bitRetrieveNull	Recupera valores NULL de coluna de vários valores. Se essa opção não for especificada, os valores NULL de coluna de vários valores serão ignorados automaticamente.
JET_bitRetrieveIgnoreDefault	Faz com que um valor NULL seja retornado quando o número de sequência solicitado for 1 e não houver valores definidos para a coluna no registro. Essa opção afeta apenas colunas com valores múltiplos.
JET_bitRetrieveLongId	Esse sinalizador é apenas para uso interno e não se destina a ser usado em seu aplicativo.
JET_bitRetrieveLongValueRefCount	Esse sinalizador é apenas para uso interno e não se destina a ser usado em seu aplicativo.

ibLongValue

O deslocamento para o primeiro byte a ser recuperado de uma coluna do tipo JET_coltypLongBinary ou JET_coltypLongText.

itagSequence

O número de sequência dos valores contidos em uma coluna com vários valores. itagSequence aqui no JET_RETRIEVECOLUMN pode ser 0. Se itagSequence for 0, o número de instâncias de uma coluna com vários valores será retornado em vez de dados de coluna. Um valor itagSequence de 0 não pode ser usado em chamadas para JetRetrieveColumn.

columnidNextTagged

A columnid da coluna marcada, com vários valores ou esparsa quando todas as colunas marcadas são recuperadas passando 0 como columnid para JetRetrieveColumn.

err

Códigos de erro e avisos retornados da recuperação da coluna.

Requisitos

Requisito	Valor
Cliente	Requer Windows Vista, Windows XP ou Windows 2000 Professional.
Servidor	Requer o Windows Server 2008, o Windows Server 2003 ou o Windows 2000 Server.
Cabeçalho	Declarado em Esent.h.

Consulte Também

JET_COLTYP
JET_COLUMNID
JET_ERR
JET_GRBIT
JET_RETRIEVECOLUMN
JetRetrieveColumn
JetRetrieveColumns