Função JetGetTableIndexInfo

Artigo
06/13/2023

Aplica-se a: Windows | Windows Server

Função JetGetTableIndexInfo

A função JetGetTableIndexInfo recupera informações sobre um índice.

    JET_ERR JET_API JetGetTableIndexInfo(
      __in          JET_SESID sesid,
      __in          JET_TABLEID tableid,
      __in          const tchar* szIndexName,
      __out         void* pvResult,
      __in          unsigned long cbResult,
      __in          unsigned long InfoLevel
    );

Parâmetros

sesid

O contexto de sessão do banco de dados a ser usado para a chamada à API.

Tableid

A tabela de banco de dados que contém o índice que contém as informações necessárias.

szIndexName

O nome do índice que contém informações que serão recuperadas.

pvResult

Ponteiro para um buffer que receberá as informações. O buffer deve ser alinhado para manter o tipo necessário. O tipo do buffer depende do parâmetro InfoLevel .

cbResult

O tamanho, em bytes, do buffer passado no parâmetro pvResult .

InfoLevel

Especifica quais informações serão armazenadas no pvResult. Os valores válidos são:

Valor	Significado
JET_IdxInfo	pvResult é interpretado como uma estrutura JET_INDEXLIST . Em caso de êxito, a estrutura JET_INDEXLIST recebe informações sobre o índice. Em caso de falha, o conteúdo do pvBuffer é indefinido.
JET_IdxInfoLCID	pvResult é interpretado como um LCID. Em caso de êxito, o LCID mantém o Identificador de Localidade do índice. Em caso de falha, o conteúdo do pvBuffer é indefinido.
JET_IdxInfoList	pvResult é interpretado como uma estrutura JET_INDEXLIST . Em caso de êxito, a estrutura JET_INDEXLIST recebe informações sobre o índice. Em caso de falha, o conteúdo do pvBuffer é indefinido.
JET_IdxInfoOLC	JET_IdxInfoOLC está obsoleto.
JET_IdxInfoResetOLC	JET_IdxInfoResetOLC está obsoleto.
JET_IdxInfoSpaceAlloc	pvResult é interpretado como um ULONG. Em caso de êxito, o ULONG mantém o uso de espaço do índice. Em caso de falha, o conteúdo do pvBuffer é indefinido.
JET_IdxInfoSysTabCursor	JET_IdxInfoSysTabCursor está obsoleto.
JET_IdxInfoLangid	JET_IdxInfoLangid foi preterido. Em vez disso, use JET_IdxInfoLCID e a macro LANGIDFROMLCID .
JET_IdxInfoCount	pvResult é interpretado como um ULONG. Em caso de êxito, o ULONG mantém a contagem de índices na tabela especificada. szIndexName é ignorado. Em caso de falha, o conteúdo do pvBuffer é indefinido.
JET_IdxInfoVarSegMac	pvResult é interpretado como um USHORT. Em caso de êxito, o USHORT mantém o valor de cbVarSegMac usado quando o índice foi criado. Consulte JET_INDEXCREATE para obter uma descrição de cbVarSegMac. Em caso de falha, o conteúdo do pvBuffer é indefinido.
JET_IdxInfoIndexId	pvResult é interpretado como um JET_INDEXID. Em caso de êxito, a estrutura JET_INDEXID recebe informações sobre o índice. Em caso de falha, o conteúdo do pvBuffer é indefinido.
JET_IdxInfoKeyMost	pvResult é interpretado como um USHORT. Em caso de êxito, o USHORT mantém o valor de cbKeyMost usado quando o índice foi criado. Consulte a estrutura JET_INDEXCREATE para obter uma descrição de cbKeyMost. Em caso de falha, o conteúdo do pvBuffer é indefinido.
JET_IdxInfoCreateIndex	pvResult é interpretado como uma estrutura JET_INDEXCREATE . Em caso de falha, o conteúdo do pvBuffer é indefinido. Windows 7: JET_IdxInfoCreateIndex é introduzido no Windows 7.
JET_IdxInfoCreateIndex2	pvResult é interpretado como uma estrutura JET_INDEXCREATE2 . Em caso de falha, o conteúdo do pvBuffer é indefinido. Windows 7: JET_IdxInfoCreateIndex2 é introduzido no Windows 7.

Valor Retornado

Essa função retorna o tipo de dados JET_ERR com um dos seguintes códigos de retorno. Para obter mais informações sobre os possíveis erros de ESE, consulte Erros extensíveis do mecanismo de armazenamento e parâmetros de tratamento de erros.

Código de retorno	Descrição
JET_errSuccess	A operação foi concluída com sucesso.
JET_errIndexNotFound	O índice especificado não pode ser encontrado na tabela especificada.
JET_wrnBufferTruncated	O buffer passado como pvResult era muito pequeno. O conteúdo do buffer é indefinido.

Comentários

JetGetIndexInfo e JetGetTableIndexInfo recuperam informações idênticas sobre um índice. A diferença está em como a tabela é especificada. JetGetIndexInfo espera um banco de dados (dbid) e o nome de uma tabela (szTableName), enquanto JetGetTableIndexInfo espera um identificador de tabela (tableid).

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.
Biblioteca	Use ESENT.lib.
DLL	Requer ESENT.dll.
Unicode	Implementado como JetGetTableIndexInfoW (Unicode) e JetGetTableIndexInfoA (ANSI).

Consulte Também

JET_COLUMNID
JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JET_INDEXCREATE
JET_INDEXID
JetGetIndexInfo

Compartilhar via

Função JetGetTableIndexInfo