JetGetTableIndexInfo-funktion

gäller för: Windows | Windows Server

JetGetTableIndexInfo-funktion

Funktionen JetGetTableIndexInfo hämtar information om ett index.

    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
    );

Parameters

sesid

Den databassessionskontext som ska användas för API-anropet.

tableid

Databastabellen som innehåller det index som innehåller nödvändig information.

szIndexName

Namnet på det index som innehåller information som ska hämtas.

pvResult

Pekare till en buffert som tar emot informationen. Bufferten bör justeras för att innehålla den typ som krävs. Typen av buffert är beroende av parametern InfoLevel .

cbResult

Storleken, i byte, på bufferten som skickades i parametern pvResult .

InfoLevel

Anger vilken information som ska lagras i pvResult. Giltiga värden är:

Value

Meaning

JET_IdxInfo

pvResult tolkas som en JET_INDEXLIST struktur. Vid lyckat resultat får JET_INDEXLIST-strukturen information om indexet. Vid fel är innehållet i pvBuffer odefinierat.

JET_IdxInfoLCID

pvResult tolkas som en LCID. Vid lyckat resultat har LCID indexets nationella identifierare. Vid fel är innehållet i pvBuffer odefinierat.

JET_IdxInfoList

pvResult tolkas som en JET_INDEXLIST struktur. Vid lyckat resultat får JET_INDEXLIST-strukturen information om indexet. Vid fel är innehållet i pvBuffer odefinierat.

JET_IdxInfoOLC

JET_IdxInfoOLC är föråldrad.

JET_IdxInfoResetOLC

JET_IdxInfoResetOLC är föråldrad.

JET_IdxInfoSpaceAlloc

pvResult tolkas som en ULONG. Vid lyckat resultat innehåller ULONG utrymmesanvändningen för indexet. Vid fel är innehållet i pvBuffer odefinierat.

JET_IdxInfoSysTabCursor

JET_IdxInfoSysTabCursor är föråldrad.

JET_IdxInfoLangid

JET_IdxInfoLangid är inaktuell. Använd JET_IdxInfoLCID i stället och LANGIDFROMLCID-makrot i stället.

JET_IdxInfoCount

pvResult tolkas som en ULONG. Vid lyckat resultat innehåller ULONG antalet index i den angivna tabellen. szIndexName ignoreras. Vid fel är innehållet i pvBuffer odefinierat.

JET_IdxInfoVarSegMac

pvResult tolkas som en USHORT. Vid framgång har USHORT värdet cbVarSegMac som användes när indexet skapades. En beskrivning av cbVarSegMac finns i JET_INDEXCREATE. Vid fel är innehållet i pvBuffer odefinierat.

JET_IdxInfoIndexId

pvResult tolkas som en JET_INDEXID. Vid lyckat resultat får JET_INDEXID-strukturen information om indexet. Vid fel är innehållet i pvBuffer odefinierat.

JET_IdxInfoKeyMost

pvResult tolkas som en USHORT. Vid lyckat resultat har USHORT värdet cbKeyMost som användes när indexet skapades. En beskrivning av cbKeyMost finns i JET_INDEXCREATE struktur. Vid fel är innehållet i pvBuffer odefinierat.

JET_IdxInfoCreateIndex

pvResult tolkas som en JET_INDEXCREATE struktur. Vid fel är innehållet i pvBuffer odefinierat.

Windows 7: JET_IdxInfoCreateIndex introduceras i Windows 7.

JET_IdxInfoCreateIndex2

pvResult tolkas som en JET_INDEXCREATE2 struktur. Vid fel är innehållet i pvBuffer odefinierat.

Windows 7: JET_IdxInfoCreateIndex2 introduceras i Windows 7.
JET_IdxInfoSpaceOwned pvResult tolkas som en ULONG. Vid lyckat ULONG resultat innehåller antalet sidor som ägs av indexet. Mer information finns i Kommentarer .

Windows 11:JET_IdxInfoSpaceOwned introduceras i Windows 11.
JET_IdxInfoSpaceAvail pvResult tolkas som en ULONG. Vid lyckat resultat ULONG innehåller det antal sidor som är tillgängliga i indexet. Mer information finns i Kommentarer .

Windows 11:JET_IdxInfoSpaceAvail introduceras i Windows 11.

Returvärde

Den här funktionen returnerar JET_ERR-datatypen med någon av följande returkoder. Mer information om möjliga ESE-fel finns i Extensible Storage Engine Errors and Error Handling Parameters (Utökningsbara lagringsmotorfel och felhanteringsparametrar).

Returkod

Description

JET_errSuccess

Åtgärden har slutförts.

JET_errIndexNotFound

Det angivna indexet finns inte i den angivna tabellen.

JET_wrnBufferTruncated

Bufferten som skickades in som pvResult var för liten. Innehållet i bufferten är odefinierat.

Remarks

JetGetIndexInfo och JetGetTableIndexInfo hämtar identisk information om ett index. Skillnaden är hur tabellen anges. JetGetIndexInfo förväntar sig en databas (dbid) och namnet på en tabell (szTableName), medan JetGetTableIndexInfo förväntar sig en tabellidentifierare (tableid).

Requirements

Krav Value

Client

Kräver Windows Vista, Windows XP eller Windows 2000 Professional.

Server

Kräver Windows Server 2008, Windows Server 2003 eller Windows 2000 Server.

Huvudet

Deklarerad i Esent.h.

Bibliotek

Använd ESENT.lib.

DLL-

Kräver ESENT.dll.

Unicode

Implementerad som JetGetTableIndexInfoW (Unicode) och JetGetTableIndexInfoA (ANSI).

Se även

JET_COLUMNID
JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JET_INDEXCREATE
JET_INDEXCREATE2JET_INDEXID
JET_INDEXLISTJetGetIndexInfo

  • Last updated on