Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
Aplica-se a: Windows | do Windows Server
Função JetGetIndexInfo
A função JetGetIndexInfo recupera informações sobre um índice.
JET_ERR JET_API JetGetIndexInfo(
__in JET_SESID sesid,
__in JET_DBID dbid,
__in const tchar* szTableName,
__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.
dbid
O identificador da base de dados a usar para a chamada API.
szTableName
O nome da tabela que contém o índice com a informação a recuperar.
szIndexName
O nome do índice com a informação a recuperar.
pvResult
Aponta para um buffer que receberá a informação desejada. 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 como pvResult.
InfoLevel
A informação que será armazenada no pvResult. As seguintes opções podem ser usadas para este parâmetro.
| 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_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_IdxInfoIndexId |
O 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_IdxInfoLangid |
JET_IdxInfoLangid está obsoleto. Usa JET_IdxInfoLCID e a macro LANGIDFROMLCID em vez disso. |
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. Windows XP: JET_IdxInfoLCID é introduzido em Windows XP. |
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 densidade-alvo (ulDensidade) do índice. Veja JET_INDEXCREATE para uma descrição da ulDensidade. Em caso de falha, o conteúdo do pvBuffer fica indefinido. |
JET_IdxInfoSysTabCursor |
JET_IdxInfoSysTabCursor está obsoleto. |
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_IdxInfoKeyMost |
PvResult é interpretado como um USHORT. Em caso de sucesso, o USHORT mantém o valor do cbKeyMost utilizado quando o índice foi criado. Veja JET_INDEXCREATE para uma descrição do cbKeyMost. Em caso de falha, o conteúdo do pvBuffer fica indefinido. Windows Vista: JET_IdxInfoKeyMost é introduzido em Windows Vista. |
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).
O espaço consumido por um índice é definido por $Used + Disponibilidade = Possuído$. Portanto, para obter o número de páginas em uso, use a fórmula $Owned - Avail = Used$ (recuperável com JET_IdxInfoSpaceOwned e JET_IdxInfoSpaceAvail).
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 JetGetIndexInfoW (Unicode) e JetGetIndexInfoA (ANSI). |
Ver também
JET_COLUMNIDJET_ERR JET_GRBITJET_INDEXCREATEJET_INDEXCREATE2JET_INDEXIDJET_INDEXLISTJET_SESIDJET_TABLEIDJetGetTableIndexInfo