JetCreateIndex-Funktion

Gilt für: Windows | Windows Server

JetCreateIndex-Funktion

Mit der JetCreateIndex-Funktion können Sie einen Index von Daten in einer ESE-Datenbank (Extensible Storage Engine) erstellen, mit der Sie bestimmte Daten schnell suchen können.

    JET_ERR JET_API JetCreateIndex(
      __in          JET_SESID sesid,
      __in          JET_TABLEID tableid,
      __in          JET_PCSTR szIndexName,
      __in          JET_GRBIT grbit,
      __in          const tchar* szKey,
      __in          unsigned long cbKey,
      __in          unsigned long lDensity
    );

Parameter

sesid

Der Datenbanksitzungskontext, der für einen bestimmten API-Aufruf verwendet werden soll.

tableid

Die Tabelle, für die ein Index erstellt wird.

szIndexName

Ein Zeiger auf eine NULL-endende Zeichenfolge, die den Namen des zu erstellenden Indexes angibt.

Der Indexname muss den folgenden Richtlinien entsprechen:

• Sie muss weniger Zeichen als JET_cbNameMost enthalten, ohne das abschließende NULL-Zeichen.

• Sie darf nur Zeichen aus den folgenden Kategorien enthalten: 0 bis 9, A bis Z, a bis z und alle Interpunktionszeichen mit Ausnahme von "!" (Ausrufezeichen), "," (Komma), "[" (öffnende Klammer) und "]" (schließende Klammer) – d. h. die ASCII-Zeichen 0x20, 0x22 bis 0x2d, 0x2f über 0x5a, 0x5c und 0x5d über 0x7f.

• Sie darf nicht mit einem Leerzeichen beginnen.

• Sie muss mindestens ein Zeichen ohne Leerzeichen enthalten.

grbit

Eine Gruppe von Bits, die die Optionen enthält, die für einen bestimmten Aufruf verwendet werden sollen. Dieser Parameter kann null oder mehr der Optionen in der JET_INDEXCREATE-Struktur enthalten.

szKey

Ein Zeiger auf eine doppelte null-endende Zeichenfolge von durch NULL getrennten Token.

Weitere Informationen zu diesem Parameter finden Sie in der JET_INDEXCREATE-Struktur .

cbKey

Die Länge des szKey-Parameters in Bytes, einschließlich der beiden abschließenden NULL-Zeichen.

lDensity

Die Prozentuale Dichte der anfänglichen Indexstruktur B+.

Weitere Informationen zu diesem Parameter finden Sie in der JET_INDEXCREATE-Struktur .

Rückgabewert

Diese Funktion gibt den Datentyp JET_ERR mit einem der in der folgenden Tabelle aufgeführten Rückgabecodes zurück. Weitere Informationen zu möglichen ESE-Fehlern finden Sie unter Erweiterbare Speichermodulfehler und Fehlerbehandlungsparameter.

Eine Liste mit zusätzlichen Fehlern, die von der JetCreateIndex-Funktion zurückgegeben werden können, finden Sie unter JetCreateIndex2.

Bemerkungen

Das Aufrufen der JetCreateIndex-Funktion ist identisch mit dem Aufrufen der JetCreateIndex2-Funktion mit einer JET_INDEXCREATE-Struktur , die die gleichen Einstellungen wie die Parameter von JetCreateIndex enthält, und einem cIndexCreate-Parameter gleich 1. Für die Felder der JET_INDEXCREATE-Struktur , die keine entsprechenden Parameter in JetCreateIndex haben, wird der Wert 0 angenommen.

Beachten Sie, dass JetCreateIndex von JetCreateIndex2 abgelöst wurde.

Anforderungen

Weitere Informationen

JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JET_INDEXCREATE
JetCreateIndex2
JetCreateTableColumnIndex
JetCreateTableColumnIndex2