SdbDeclareIndex function

Declares a new index in the specified database.

Syntax

BOOL WINAPI SdbDeclareIndex(
  _In_  PDB     pdb,
  _In_  TAG     tWhich,
  _In_  TAG     tKey,
  _In_  DWORD   dwEntries,
  _In_  BOOL    bUniqueKey,
  _Out_ INDEXID *piiIndex
);

Parameters

• pdb [in]
  A handle to the shim database.

• tWhich [in]
  This parameter must be TAG_TYPE_LIST.

• tKey [in]
  The TAG that specifies the type to be used as the key. This parameter cannot be TAG_TYPE_LIST.

• dwEntries [in]
  The number of entries to allocate in the index.

• bUniqueKey [in]
  If this parameter is TRUE, the index is a unique-key index.

• piiIndex [out]
  The resulting INDEXID of the newly declared index.

Return value

The function returns TRUE on success or FALSE on failure.

Remarks

Call this function before writing tags to the new index.

Requirements

See also

INDEXID

SdbCommitIndexes

SdbStartIndexing

SdbStopIndexing