Funzione JetGetTableIndexInfo

Si applica a: Windows | Windows Server

Funzione JetGetTableIndexInfo

La funzione JetGetTableIndexInfo recupera le informazioni su un indice.

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

Parametri

sesid

Contesto della sessione di database da usare per la chiamata API.

TableID

Tabella di database che contiene l'indice che contiene le informazioni necessarie.

szIndexName

Nome dell'indice contenente le informazioni che verranno recuperate.

pvResult

Puntatore a un buffer che riceverà le informazioni. Il buffer deve essere allineato per contenere il tipo richiesto. Il tipo del buffer dipende dal parametro InfoLevel .

cbResult

Dimensione, in byte, del buffer passato nel parametro pvResult .

InfoLevel

Specifica le informazioni che verranno archiviate in pvResult. I valori validi sono:

Valore

Significato

JET_IdxInfo

pvResult viene interpretato come una struttura JET_INDEXLIST . In seguito all'esito positivo, la struttura JET_INDEXLIST riceve informazioni sull'indice. In caso di errore, il contenuto di pvBuffer non è definito.

JET_IdxInfoLCID

pvResult viene interpretato come un identificatore LCID. In seguito all'esito positivo, l'LCID include l'identificatore delle impostazioni locali dell'indice. In caso di errore, il contenuto di pvBuffer non è definito.

JET_IdxInfoList

pvResult viene interpretato come una struttura JET_INDEXLIST . In seguito all'esito positivo, la struttura JET_INDEXLIST riceve informazioni sull'indice. In caso di errore, il contenuto di pvBuffer non è definito.

JET_IdxInfoOLC

JET_IdxInfoOLC è obsoleto.

JET_IdxInfoResetOLC

JET_IdxInfoResetOLC è obsoleto.

JET_IdxInfoSpaceAlloc

pvResult viene interpretato come ulong. In seguito all'esito positivo, ULONG determinerà l'utilizzo dello spazio dell'indice. In caso di errore, il contenuto di pvBuffer non è definito.

JET_IdxInfoSysTabCursor

JET_IdxInfoSysTabCursor è obsoleto.

JET_IdxInfoLangid

JET_IdxInfoLangid è deprecato. In alternativa, usare JET_IdxInfoLCID e la macro LANGIDFROMLCID .

JET_IdxInfoCount

pvResult viene interpretato come ulong. In seguito all'esito positivo, ULONG include il conteggio degli indici nella tabella specificata. szIndexName viene ignorato. In caso di errore, il contenuto di pvBuffer non è definito.

JET_IdxInfoVarSegMac

pvResult viene interpretato come UShort. In caso di esito positivo, il USHORT include il valore di cbVarSegMac usato durante la creazione dell'indice. Per una descrizione di cbVarSegMac, vedere JET_INDEXCREATE . In caso di errore, il contenuto di pvBuffer non è definito.

JET_IdxInfoIndexId

pvResult viene interpretato come JET_INDEXID. In seguito all'esito positivo, la struttura JET_INDEXID riceve informazioni sull'indice. In caso di errore, il contenuto di pvBuffer non è definito.

JET_IdxInfoKeyMost

pvResult viene interpretato come UShort. In caso di esito positivo, il USHORT include il valore di cbKeyMost usato durante la creazione dell'indice. Per una descrizione di cbKeyMost, vedere la struttura JET_INDEXCREATE . In caso di errore, il contenuto di pvBuffer non è definito.

JET_IdxInfoCreateIndex

pvResult viene interpretato come una struttura JET_INDEXCREATE . In caso di errore, il contenuto di pvBuffer non è definito.

Windows 7: JET_IdxInfoCreateIndex è stato introdotto in Windows 7.

JET_IdxInfoCreateIndex2

pvResult viene interpretato come una struttura JET_INDEXCREATE2 . In caso di errore, il contenuto di pvBuffer non è definito.

Windows 7: JET_IdxInfoCreateIndex2 è stato introdotto in Windows 7.

Valore restituito

Questa funzione restituisce il tipo di dati JET_ERR con uno dei seguenti codici restituiti. Per ulteriori informazioni sugli errori ESE possibili, vedere la pagina relativa agli errori e ai parametri di gestione deglierrori del motore di archiviazione estensibile .

Codice restituito

Descrizione

JET_errSuccess

Operazione riuscita.

JET_errIndexNotFound

Impossibile trovare l'indice specificato nella tabella specificata.

JET_wrnBufferTruncated

Il buffer passato come pvResult è troppo piccolo. Il contenuto del buffer non è definito.

Commenti

JetGetIndexInfo e JetGetTableIndexInfo recuperano informazioni identiche su un indice. La differenza consiste nel modo in cui viene specificata la tabella. JetGetIndexInfo prevede un database (dbid) e il nome di una tabella (szTableName), mentre JetGetTableIndexInfo prevede un identificatore di tabella (TableID).

Requisiti

Client

Richiede Windows Vista, Windows XP o Windows 2000 Professional.

Server

Richiede Windows Server 2008, Windows Server 2003 o Windows 2000 Server.

Intestazione

Dichiarata in esent. h.

Libreria

Usare ESENT. lib.

DLL

Richiede ESENT.dll.

Unicode

Implementato come JetGetTableIndexInfoW (Unicode) e JetGetTableIndexInfoA (ANSI).

Vedere anche

JET_COLUMNID
JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JET_INDEXCREATE
JET_INDEXID
JetGetIndexInfo