Función JetGetIndexInfo

se aplica a: Windows | Windows Server

Función JetGetIndexInfo

La función JetGetIndexInfo recupera información sobre un í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

Contexto de sesión de base de datos que se va a usar para la llamada API.

dbid

Identificador de base de datos que se va a usar para la llamada API.

szTableName

Nombre de la tabla que contiene el índice con la información que se va a recuperar.

szIndexName

Nombre del índice con la información que se va a recuperar.

pvResult

Puntero a un búfer que recibirá la información deseada. El búfer debe alinearse para contener el tipo necesario. El tipo del búfer depende del parámetro InfoLevel .

cbResult

Tamaño, en bytes, del búfer pasado como pvResult.

InfoLevel

La información que se almacenará en pvResult. Las siguientes opciones se pueden usar para este parámetro.

Value Meaning

JET_IdxInfo

pvResult se interpreta como una estructura JET_INDEXLIST . Si se ejecuta correctamente, la estructura JET_INDEXLIST recibe información sobre el índice. En caso de error, el contenido de pvBuffer no está definido.

JET_IdxInfoCount

pvResult se interpreta como un ULONG. Si se ejecuta correctamente, ULONG contiene el recuento de índices en la tabla especificada. szIndexName se omite. En caso de error, el contenido de pvBuffer no está definido.

JET_IdxInfoIndexId

pvResult se interpreta como un JET_INDEXID. Si se ejecuta correctamente, la estructura JET_INDEXID recibe información sobre el índice. En caso de error, el contenido de pvBuffer no está definido.

JET_IdxInfoLangid

JET_IdxInfoLangid está en desuso. Use JET_IdxInfoLCID y la macro LANGIDFROMLCID en su lugar.

JET_IdxInfoLCID

pvResult se interpreta como LCID. Si se ejecuta correctamente, el LCID contiene el identificador de configuración regional del índice. En caso de error, el contenido de pvBuffer no está definido.

Windows XP: JET_IdxInfoLCID se introduce en Windows XP.

JET_IdxInfoList

pvResult se interpreta como una estructura JET_INDEXLIST . Si se ejecuta correctamente, la estructura JET_INDEXLIST recibe información sobre el índice. En caso de error, el contenido de pvBuffer no está definido.

JET_IdxInfoOLC

JET_IdxInfoOLC está obsoleto.

JET_IdxInfoResetOLC

JET_IdxInfoResetOLC está obsoleto.

JET_IdxInfoSpaceAlloc

pvResult se interpreta como un ULONG. Si se ejecuta correctamente, ULONG contiene la densidad de destino (ulDensity) del índice. Consulte JET_INDEXCREATE para obtener una descripción de ulDensity. En caso de error, el contenido de pvBuffer no está definido.

JET_IdxInfoSysTabCursor

JET_IdxInfoSysTabCursor está obsoleto.

JET_IdxInfoVarSegMac

pvResult se interpreta como un USHORT. Si se ejecuta correctamente, USHORT contiene el valor de cbVarSegMac usado cuando se creó el índice. Consulte JET_INDEXCREATE para obtener una descripción de cbVarSegMac. En caso de error, el contenido de pvBuffer no está definido.

JET_IdxInfoKeyMost

pvResult se interpreta como un USHORT. Si se ejecuta correctamente, USHORT contiene el valor de cbKeyMost usado cuando se creó el índice. Consulte JET_INDEXCREATE para obtener una descripción de cbKeyMost. En caso de error, el contenido de pvBuffer no está definido.

Windows Vista: JET_IdxInfoKeyMost se introduce en Windows Vista.

JET_IdxInfoCreateIndex

pvResult se interpreta como una estructura JET_INDEXCREATE . En caso de error, el contenido de pvBuffer no está definido.

Windows 7: JET_IdxInfoCreateIndex se introduce en Windows 7.

JET_IdxInfoCreateIndex2

pvResult se interpreta como una estructura JET_INDEXCREATE2 . En caso de error, el contenido de pvBuffer no está definido.

Windows 7: JET_IdxInfoCreateIndex2 se introduce en Windows 7.
JET_IdxInfoSpaceOwned pvResult se interpreta como .ULONG Si se ejecuta correctamente, ULONG contiene el número de páginas que pertenecen al índice. Consulte Comentarios para más información.

Windows 11:JET_IdxInfoSpaceOwned se introduce en Windows 11.
JET_IdxInfoSpaceAvail pvResult se interpreta como .ULONG Si se ejecuta correctamente, ULONG contiene el número de páginas disponibles en el índice. Consulte Comentarios para más información.

Windows 11:JET_IdxInfoSpaceAvail se introduce en Windows 11.

Valor devuelto

Esta función devuelve el tipo de datos JET_ERR con uno de los siguientes códigos de retorno. Para obtener más información sobre los posibles errores de ESE, vea Extensible Storage Engine Errors and Error Handling Parameters.

Código de retorno

Description

JET_errSuccess

La operación se completó correctamente.

JET_errIndexNotFound

No se encuentra el índice especificado en la tabla especificada.

JET_wrnBufferTruncated

El búfer pasado como pvResult era demasiado pequeño. El contenido del búfer no está definido.

Observaciones

JetGetIndexInfo y JetGetTableIndexInfo recuperan información idéntica sobre un índice. La diferencia es la forma en que se especifica la tabla. JetGetIndexInfo espera una base de datos (dbid) y el nombre de una tabla (szTableName), mientras que JetGetTableIndexInfo espera un identificador de tabla (tableid).

El espacio consumido por un índice se define mediante $Used + Avail = Owned$. Por lo tanto, para obtener el número de páginas en uso, use la fórmula $Owned - Avail = Used$ (recuperable con JET_IdxInfoSpaceOwned y JET_IdxInfoSpaceAvail).

Requisitos

Requirement Value

Client

Requiere Windows Vista, Windows XP o Windows 2000 Professional.

Servidor

Requiere Windows Server 2008, Windows Server 2003 o Windows servidor 2000.

Encabezado

Declarado en Esent.h.

Biblioteca

Use ESENT.lib.

DLL de

Requiere ESENT.dll.

Unicode

Se implementa como JetGetIndexInfoW (Unicode) y JetGetIndexInfoA (ANSI).

Véase también

JET_COLUMNIDJET_ERRJET_GRBITJET_INDEXCREATEJET_INDEXCREATE2JET_INDEXID JET_INDEXLIST JET_SESID JET_TABLEIDJetGetTableIndexInfo

  • Last updated on