struct dtsListIndexJob : public dtsJobBase { long outputStringMaxSize; long listFlags; long searchFlags; long fuzziness; const char * toMatch; const char * indexPath; const char * outputFile; dtsStringHandle outputString; long fOutputStringWasTruncated; };
dtsearch.h
|
Members |
Description |
|
long outputStringMaxSize; |
Maximum size of the output string to generate |
|
long listFlags; |
ListIndexFlags specifying the type of list to generate |
|
long searchFlags; |
SearchFlags specifying search features to be used in matching the toMatch expression, such as fuzziness, stemming, etc |
|
long fuzziness; |
If the dtsSearchFuzzy flag is set in searchFlags, set the fuzziness value from 1 to 10 to specify the level of fuzzy searching to apply. |
|
const char * toMatch; |
toMatch is an optional search expression specifying the text to match against items being listed. For example, to list all field names starting with "A", you would set listFlags to dtsListIndexFields, and set toMatch to "A*". |
|
const char * indexPath; |
Location of the index to list. |
|
const char * outputFile; |
Name of file to create (if the dtsListIndexReturnString flag is not set |
|
dtsStringHandle outputString; |
If the dtsListIndexReturnString flag is set, the list will be returned through a dtsStringHandle. The dtsStringHandle must be released by the caller. |
|
long fOutputStringWasTruncated; |
If true, the output was halted due to outputStringMaxSize before all items were listed |
List the contents of an index
|
Copyright (c) 1995-2008 dtSearch Corp. All rights reserved.
|