You are here: C++ API > Enumerations > IndexingFlags Enumeration
Close
dtSearch Text Retrieval Engine Programmer's Reference
IndexingFlags Enumeration

File: dtsearch.h

Syntax
C++
enum IndexingFlags { dtsAlwaysAdd = 0x0001, dtsCheckDiskSpace = 0x0002, dtsIndexCreateCaseSensitive = 0x0004, dtsIndexCreateAccentSensitive = 0x0008, dtsIndexCreateRelativePaths = 0x0010, dtsIndexResumeUpdate = 0x0020, dtsIndexCacheText = 0x0040, dtsIndexCacheOriginalFile = 0x0080, dtsIndexCreateVersion6 = 0x00100, dtsIndexCacheTextWithoutFields = 0x00200, dtsIndexKeepExistingDocIds = 0x00400, dtsIndexTokenizeEnumerableFields = 0x00800, dtsIndexLowerCaseEnumerableFields = 0x01000, dtsIndexEnableAutoEnumerableFields = 0x02000, dtsIndexCreateOptionalAccentSensitive = 0x4000, dtsIndexCreatePreserveExistingSettings = 0x8000, dtsIndexMultithread = 0x10000, dtsIndexSkipSymbolicLinks = 0x80000 };
Members
Description
dtsAlwaysAdd = 0x0001
Reindex a document even if the modification date and size are unchanged.
dtsCheckDiskSpace = 0x0002
Check for sufficient disk space before indexing. In the C++ API only, this flag will cause a dtsAskDiskFullOverride message to be sent through the error handler callback (dtsErrorHandler.pNotifyFn) giving the calling application the option to cancel the update.
dtsIndexCreateCaseSensitive = 0x0004
Can be used in indexingFlags instead of the createFlags
dtsIndexCreateAccentSensitive = 0x0008
Create an accent-sensitive index.
dtsIndexCreateRelativePaths = 0x0010
Use relative rather than absolute paths in storing document locations.
dtsIndexResumeUpdate = 0x0020
Resume an earlier index update that did not complete. (Version 7 indexes only.)
dtsIndexCacheText = 0x0040
Compress and store the text of documents in the index, for use in generating Search Reports and highlighting hits. (This flag must be set when an index is created.) See Caching documents.
dtsIndexCacheOriginalFile = 0x0080
Compress and store documents in the index, for use in generating Search Reports and highlighting hits. (This flag must be set when an index is created.) See Caching documents.
dtsIndexCreateVersion6 = 0x00100
Obsolete -- version 6 indexes are no longer supported
dtsIndexCacheTextWithoutFields = 0x00200
When text caching is enabled, do not cache any fields that were provided through the data source API. See Caching documents.
dtsIndexKeepExistingDocIds = 0x00400
Preserve existing document ids following a compression of an index or a merge of two or more indexes.
dtsIndexTokenizeEnumerableFields = 0x00800
Use Options.StoredFieldDelimiterChar to tokenize enumerable fields into separate values when indexing. For example, if StoredFieldDelimiterChar is '|' and the SampleField contains the value "First|Second|Third", the indexer will create three separate enumerable field instances for SampleField in the document, "First", "Second", and "Third", instead of a single instance containing "First|Second|Third". Because StoredFieldDelimiterChar is used to delimit multiple instances of the same field in a document, the same result will occur if the document contains three separate instances of SampleField, containing "First", "Second", and "Third".
dtsIndexLowerCaseEnumerableFields = 0x01000
Convert enumerable fields to lower case
dtsIndexEnableAutoEnumerableFields = 0x02000
Enable automatically-generated enumerable fields
dtsIndexCreateOptionalAccentSensitive = 0x4000
Summary
Create an index with optional accent sensitivity (ICU integration required)
Remarks
If an index was created with the dtsIndexCreateOptionalAccentSensitive, then at search time accents in search requests can be either required for a match or ignored. Set dtsSearchRequireAccents to make accents required.
In an accents-optional index, accented letters can be made significant for matching purposes, but unaccented letters will still always match both accented and unaccented forms.
For example, a search for "abc" will find both "abc" and "äbc". A search for "äbc" will find different results depending on whether the flag dtsSearchRequireAccents is set in the SearchJob. If dtsSearchRequireAccents is set, then "äbc" and will match "äbc" and will not match "abc". If dtsSearchRequireAccents is not set, then "äbc" will match both "äbc" and "abc".
ICU integration is required for dtsIndexCreateOptionalAccentSensitive to work.
dtsIndexCreatePreserveExistingSettings = 0x8000
Summary
Preserve the existing settings in an index when clearing it before updating.
Remarks
Normally when an index is updated with ActionCreate=true in the IndexJob, the settings in the index (noise word lists, alphabet files, ICU version if any) are updated to the current settings.
If the index already exists, and you want to clear it without modifying the settings that were originally used to create the index, set the flag dtsIndexCreatePreserveExistingSettings to tell dtSearch to read the settings currently in the index and preserve them when clearing the index.
dtsIndexMultithread = 0x10000
Summary
Build index using multiple threads
Remarks
dtsIndexSkipSymbolicLinks = 0x80000
Do not follow symbolic links, junction points, etc. when indexing.

Values for indexing flags in dtsIndexJob

Copyright (c) 1995-2021 dtSearch Corp. All rights reserved.