Last modified: March 09, 2015
Applies to: Windows | Windows Server
The JetCreateIndex4W function creates indexes over data in an Extensible Storage Engine (ESE) database, which can be used to locate specific data quickly.
The JetCreateIndex4W function was introduced in the Windows 8 operating system.
JET_ERR JET_API JetCreateIndex4W( __in JET_SESID sesid, __in JET_TABLEID tableid, __in JET_INDEXCREATE2* pindexcreate, __in unsigned long cIndexCreate );
The database session context to use for the API call.
The table on which the index will be created.
An array of JET_INDEXCREATE2 structures, each of which defines an index to be created.
The number of elements in the pindexcreate array.
This function returns the JET_ERR data type with one of the return codes listed in the following table. For more information about the possible ESE errors, see Extensible Storage Engine Errors and Error Handling Parameters.
The operation completed successfully.
An attempt was made to index over an escrow-update or SLV column (note that SLV columns are deprecated).
An attempt was made to index over a nonexistent column. An attempt to conditionally index over a nonexistent column can also produce this error.
This error will be returned if the ulDensity member of the JET_INDEXCREATE2 structure is set to a number less than 20 or greater than 100.
An attempt to define two identical indexes was made.
An attempt was made to specify more than one primary index for a table. A table must have exactly one primary index. If no primary index is specified, the database engine will transparently create one.
An invalid index definition was specified. The following are some possible reasons for this error:
Applies to versions of Windows starting with Windows XP. A JET_TUPLELIMITS structure was specified, and its limits are not supported. For more information, see the remarks section of the JET_TUPLELIMITS structure.
Applies to versions of Windows starting with Windows XP. A tuple index cannot be unique (grbit must not have both JET_bitIndexTuples and JET_bitIndexUnique set).
Applies to versions of Windows starting with Windows XP. A tuple index can only be over a single column (that is, the grbit member of the JET_INDEXCREATE2 structure has JET_bitIndexTuples set, and the szKey member of the JET_INDEXCREATE2 structure specifies more than one column).
Applies to versions of Windows starting with Windows XP. A tuple index cannot be a primary index (that is, the grbit member of the JET_INDEXCREATE2 structure must not have both JET_bitIndexPrimary and JET_bitIndexTuples set).
Applies to versions of Windows starting with Windows XP. A tuple index can only be on a text or Unicode column. An attempt to index other columns (for example, binary columns) will result in JET_errIndexTuplesTextColumnsOnly.
Applies to versions of Windows starting with Windows XP. A tuple index does not allow the cbVarSegMac member of the JET_INDEXCREATE2 structure to be set.
An attempt was made to create an index without version information while in a transaction.
The index definition is invalid because the grbit member of the JET_INDEXCREATE2 structure contains inconsistent values. The following are some possible reasons:
When creating several indexes at once (that is, if the cIndexCreate parameter is greater than one), none of the indexes may contain any of the following bits:
An invalid Locale ID (LCID) was passed in (either through the lcid member in the JET_UNICODEINDEX structure, which the pidxunicode member in the JET_INDEXCREATE2 structure contains a pointer to, or through the lcid member of the JET_INDEXCREATE2 structure).
An invalid index name was specified. See JET_INDEXCREATE2 for more details.
An invalid parameter was passed into the API. The following are some reasons why this error may be returned:
An error occurred while trying to normalize a Unicode column. This can be caused by running out of system resources.
An element of the JET space hints structure was not correct or actionable.
The JetCreateIndex4W function iterates through the indexes given in the pindexcreate parameter, and will sometimes abort on the first failure. Any indexes after the first index with an error may not have been attempted, even though the err member of the JET_INDEXCREATE2 structure contains JET_errSuccess.
Requires Windows 8.
Requires Windows Server 2012.
Declared in Esent.h.