Função JetGetTableIndexInfo

Aplica-se a: Windows | do 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 da sessão da base de dados a usar para a chamada API.

tableid

A tabela da base de dados que contém o índice que contém a informação necessária.

szIndexName

O nome do índice que contém a informação que será recuperada.

pvResult

Aponta para um buffer que irá receber a informação. O buffer deve estar alinhado para conter 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 que informação será armazenada no pvResult. Os valores válidos são:

Value

Meaning

JET_IdxInfo

O pvResult é interpretado como uma estrutura JET_INDEXLIST . Em caso de sucesso, a estrutura JET_INDEXLIST recebe informação sobre o índice. Em caso de falha, o conteúdo do pvBuffer fica indefinido.

JET_IdxInfoLCID

O pvResult é interpretado como um LCID. Em caso de sucesso, o LCID mantém o Identificador de Localização do índice. Em caso de falha, o conteúdo do pvBuffer fica indefinido.

JET_IdxInfoList

O pvResult é interpretado como uma estrutura JET_INDEXLIST . Em caso de sucesso, a estrutura JET_INDEXLIST recebe informação sobre o índice. Em caso de falha, o conteúdo do pvBuffer fica indefinido.

JET_IdxInfoOLC

JET_IdxInfoOLC está obsoleto.

JET_IdxInfoResetOLC

JET_IdxInfoResetOLC está obsoleto.

JET_IdxInfoSpaceAlloc

pvResult é interpretado como um ULONG. Em caso de sucesso, o ULONG mantém a utilização de espaço do índice. Em caso de falha, o conteúdo do pvBuffer fica indefinido.

JET_IdxInfoSysTabCursor

JET_IdxInfoSysTabCursor está obsoleto.

JET_IdxInfoLangid

JET_IdxInfoLangid está obsoleto. Use JET_IdxInfoLCID em vez disso, e a macro LANGIDFROMLCID .

JET_IdxInfoCount

pvResult é interpretado como um ULONG. Em caso de sucesso, o ULONG mantém a contagem de índices na tabela especificada. szIndexName é ignorado. Em caso de falha, o conteúdo do pvBuffer fica indefinido.

JET_IdxInfoVarSegMac

PvResult é interpretado como um USHORT. Em caso de sucesso, o USHORT mantém o valor do cbVarSegMac usado quando o índice foi criado. Veja JET_INDEXCREATE para uma descrição do cbVarSegMac. Em caso de falha, o conteúdo do pvBuffer fica indefinido.

JET_IdxInfoIndexId

PvResult é interpretado como um JET_INDEXID. Em caso de sucesso, a estrutura JET_INDEXID recebe informação sobre o índice. Em caso de falha, o conteúdo do pvBuffer fica indefinido.

JET_IdxInfoKeyMost

PvResult é interpretado como um USHORT. Em caso de sucesso, o USHORT mantém o valor do cbKeyMost utilizado quando o índice foi criado. Consulte a estrutura JET_INDEXCREATE para uma descrição do cbKeyMost. Em caso de falha, o conteúdo do pvBuffer fica indefinido.

JET_IdxInfoCreateIndex

o pvResult é interpretado como uma estrutura JET_INDEXCREATE . Em caso de falha, o conteúdo do pvBuffer fica indefinido.

Windows 7: JET_IdxInfoCreateIndex é introduzido em Windows 7.

JET_IdxInfoCreateIndex2

o pvResult é interpretado como uma estrutura JET_INDEXCREATE2 . Em caso de falha, o conteúdo do pvBuffer fica indefinido.

Windows 7: JET_IdxInfoCreateIndex2 é introduzido em Windows 7.
JET_IdxInfoSpaceOwned pvResult é interpretado como um ULONG. Em caso de sucesso, mantém ULONG o número de páginas pertencentes ao índice. Consulte Comentários para obter mais informações.

Windows 11:JET_IdxInfoSpaceOwned é introduzido em Windows 11.
JET_IdxInfoSpaceAvail pvResult é interpretado como um ULONG. Em caso de sucesso, mantém ULONG o número de páginas disponíveis no índice. Consulte Comentários para obter mais informações.

Windows 11:JET_IdxInfoSpaceAvail é introduzido em Windows 11.

Valor de retorno

Esta função devolve o JET_ERR tipo de dado com um dos seguintes códigos de retorno. Para mais informações sobre os possíveis erros ESE, consulte Erros do Motor de Armazenamento Extensível e Parâmetros de Gestão de Erros.

Código de retorno

Description

JET_errSuccess

A operação foi concluída com êxito.

JET_errIndexNotFound

O índice especificado não pode ser encontrado na tabela especificada.

JET_wrnBufferTruncated

O buffer passou porque o pvResult era demasiado pequeno. O conteúdo do buffer é indefinido.

Remarks

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

Requirements

Requisito Value

Cliente

Requer Windows Vista, Windows XP ou Windows 2000 Professional.

Server

Requer Windows Server 2008, Windows Server 2003 ou Windows 2000 Server.

Cabeçalho

Declarado em Esent.h.

Biblioteca

Usa o ESENT.lib.

DLL

Requer ESENT.dll.

Unicode

Implementado como JetGetTableIndexInfoW (Unicode) e JetGetTableIndexInfoA (ANSI).

Ver também

JET_COLUMNID
JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JET_INDEXCREATE
JET_INDEXCREATE2JET_INDEXID
JET_INDEXLISTJetGetIndexInfo

  • Last updated on