Links
dtSearch Text Retrieval Engine Programmer's Reference 7.70
dtsIndexJob Structure
Data Members | Classes | Legend | Members | Methods | Send Feedback

Describes an indexing task to be performed.

struct dtsIndexJob : public dtsJobBase {
  char indexName[IndexNameLen];
  char indexPath[FileNameLen];
  short allowConcurrentAccess;
  dtsIndexJobAction action;
  dtsIndexJobCreateFlags createFlags;
  struct dtsFileSpec toAdd;
  char toRemoveList[FileNameLen];
  const char * tempFileDir;
  struct dtsDataSource * dataSourceToIndex;
  const char * storedFields;
  long indexingFlags;
  long maxTextToCache;
  long autoCommitIntervalMB;
  long maxMemToUseMB;
  void DTPROC (* pOnIndexWordFn)(void *pOnIndexWordData, struct dtsOnIndexWordInfo *info);
  void * pOnIndexWordData;
  long startingDocId;
  const char * enumerableFields;
};
File

dtsearch.h

Remarks

Call dtssDoIndexJob to execute a dtsIndexJob.

Data Members
dtsIndexJob Structure
Data Member 
Description 
Specifies whether to create, add documents to, compress, or remove items from the index. 
Obsolete. 
Automatically commit index changes to disk after this many megabytes have been indexed 
Specifies whether the index to create should be case-sensitive, accent-sensitive, or use relative paths 
Pointer to a dtsDataSource
Used to specify that the text in certain fields should be stored in the index in a way that permits unique field values to be enumerated quickly. 
Flags controlling the indexing process. 
Name of the index to create. 
Directory where the index is located. 
MaxMemToUseMB controls the size of the memory buffers that dtSearch can use to sort words during indexing. 
Maximum size of a document to cache in the index, if caching is enabled for this index 
Data to pass to pOnIndexWordFn 
The pOnIndexWordFn can be used to provide a callback to modify the text of words as they are being indexed. 
If non-zero, the first doc id to assign to documents in this index. 
Used to specify that the text in certain fields should be collected, stored in the index, and returned in searches. 
Folder to use instead of the index folder for temporary files during indexing. 
Specifies files to be added to the index if action.add is true 
Name of file containing a list of files to be deleted from the index 
Group
Methods
dtsIndexJob Structure
Method 
Description 
Clear all data in a dtsIndexJob 
copy 
Copy another dtsIndexJob (shallow copy) 
Legend
 
Data Member 
 
Method 
Links
You are here: C++ API > Classes > dtsIndexJob Structure
Copyright (c) 1995-2012 dtSearch Corp. All rights reserved.