Links
dtSearch Text Retrieval Engine Programmer's Reference
dtsIndexProgressInfo Structure
Structs, Records, Enums | Send Feedback
struct dtsIndexProgressInfo {
  long updateType;
  long step;
  const char * indexPath;
  const char * driveName;
  long percentDone;
  long bytesToIndex;
  long filesToIndex;
  long filesToCheck;
  long filesChecked;
  long docBytesReadKB;
  long bytesRead;
  long filesRead;
  long docsRead;
  struct dtsIndexFileInfo file;
  long docBytesMerged;
  long currMergePercent;
  long docsInIndex;
  long wordsInIndex;
  long elapsedSeconds;
  long diskAvail;
  long binaryCount;
  long openFailures;
  long compressPercentDone;
  long encryptedCount;
  long diskAvailKB;
  long docsRemovedFromIndex;
  long bytesToIndexKB;
  long bytesReadKB;
  long cancelFlag;
  long indexPercentFull;
  long estRemaining;
  long fieldCount;
  __int64 bytesToIndex64;
  __int64 bytesRead64;
  __int64 docBytesRead64;
  long partiallyEncryptedCount;
  long partiallyCorruptCount;
  long fileInfoFlags;
};
File

dtsearch.h

Members
Members 
Description 
long updateType; 
A dtsMessageCode identifying the reason for this update 
long step; 
IndexingStep enum Name of the index being updated 
const char * indexPath; 
Location of the index being updated 
const char * driveName; 
Drive where the index is located 
long percentDone; 
The percentage of the files that have been indexed 
long bytesToIndex; 
Number bytes to index. Deprecated: Use bytesToIndexKB or bytesToIndex64 
long filesToIndex; 
Number of files to index 
long filesToCheck; 
Number of files in the selected folders to check to see if they have been indexed 
long filesChecked; 
Number of files in the selected folders that have been checked to see if they need to be indexed 
long docBytesReadKB; 
Kilobytes of document data that have been read so far 
long bytesRead; 
Bytes of document data that have been read so far. Deprecated: Use docBytesReadKB 
long filesRead; 
Number of files read so far 
long docsRead; 
Number of documents read so far (a single file may include more than one document) 
struct dtsIndexFileInfo file; 
Current file info 
long docBytesMerged; 
bytes of docs that have been fully processed 
long currMergePercent; 
How far along is the current merge process 
long docsInIndex; 
Number of documents in the index 
long wordsInIndex; 
Number of unique words in the index 
long elapsedSeconds; 
Seconds since the index job started 
long diskAvail; 
Disk space free on index drive 
long binaryCount; 
Number of files not indexed because they were determined to be binary. (Handling of binary files is controlled by dtssSetOptions.) 
long openFailures; 
Number of files not indexed because they could not be accessed 
long compressPercentDone; 
If step is ixsCompressing, the percentage of the index that has been compressed 
long encryptedCount; 
Number of files not indexed because they were encrypted. 
long diskAvailKB; 
Kilobytes of disk space available on the drive where the index is located. If the size of the drive cannot be determined, -1 is reported 
long docsRemovedFromIndex; 
Number of deleted documents removed from the index 
long bytesToIndexKB; 
Total size of the files to be indexed, in kilobytes 
long bytesReadKB; 
Total size of the files indexed so far, in kilobytes 
long cancelFlag; 
dtsAbort, dtsContinue, or dtsAbortImmediate, depending on whether this index job was cancelled 
long indexPercentFull; 
Percentage of the maximum possible size of this index 
long estRemaining; 
Estimated number of seconds remaining in the index job 
long fieldCount; 
Number of field names in the index 
__int64 bytesToIndex64; 
Total size of the files to be indexed 
__int64 bytesRead64; 
Total size of the files indexed so far 
__int64 docBytesRead64; 
Total amount of document data that have been read so far. 
long partiallyEncryptedCount; 
Number of documents that were partially encrypted 
long partiallyCorruptCount; 
Number of documents that were partially corrupt 
long fileInfoFlags; 
FileInfoFlags value with the result of the last file indexed 
Description

Reported through the status notification callback in a dtsIndexJob

Group
Links
You are here: C++ API > Structs, Records, Enums > dtsIndexProgressInfo Structure
Copyright (c) 1995-2008 dtSearch Corp. All rights reserved.