You are here: C++ API > Classes > dtsFileConvertJob2 Structure
Close
dtSearch Text Retrieval Engine Programmer's Reference
dtsFileConvertJob2 Structure

Converts files to HTML, RTF, or text, optionally marking hits with caller-supplied tags.

File: dtsearch.h

Syntax
C++
struct dtsFileConvertJob2 : public dtsJobBase { struct dtsOutputInfo * output; const char * inputFile; struct dtsInputStream * inputSource; long hitCount; long * hits; long flags; const char * alphabetLocation; long typeId; long docId; const char * indexRetrievedFrom; long detectedTypeId; long indexedBy; const char * encodedSearchItem; dtsExtractionOptions * extractionOptions; const char * hitsByWord; dtsIndexCacheHandle indexCacheHandle; enum MergeStep { dtsIndexMergeCheckingDocs = 1, dtsIndexMergeMergingDocs = 2, dtsIndexMergeMergingWords = 3 }; struct dtsMergeStatusInfo { const char * text; long docsChecked; long docsToMerge; long docsMerged; long wordsToMerge; long wordsMerged; long step; long docsAdded; long docsSkipped; long docsUpdated; long percentDone; }; struct dtsIndexMergeJob : public dtsJobBase { const char * indexesToMerge; long iTargetIndex; long fAllowConcurrentAccess; long fClearTarget; long result; long mergeFlags; }; enum VerifyStep { dtsIndexVerifyCheckingDocs = 1, dtsIndexVerifyCheckingWords = 2, dtsIndexVerifyCorrupt = 3, dtsIndexVerifyDone = 4 }; struct dtsVerifyStatusInfo { const char * text; long docsToVerify; long docsVerified; long wordsToVerify; long wordsVerified; long step; long percentDone; unsigned long kbytesInIndex; unsigned long kwordsInIndex; }; struct dtsIndexVerifyJob : public dtsJobBase { const char * indexPath; long result; }; struct dtsVersionInfo { long minorVersion; long majorVersion; long build; }; struct dtsConvertPathRequest { dtsErrorInfo * errorHandler; long flags; char * dest; long maxLen; const char * path; long siteId; const char * registryKey; }; struct dtsCrashHandlerInfo { void * pData; void (* pNotifyFn)(void *pData, const char *logName); char appName[40]; char appVersion[40]; char logName[256]; const char * logName2; const char * miniDumpName; }; enum ListIndexFlags { dtsListIndexWords = 0x00000001, dtsListIndexFiles = 0x00000002, dtsListIndexFields = 0x00000004, dtsListIndexIncludeCount = 0x00000008, dtsListIndexReturnString = 0x00000010, dtsListIndexIncludeField = 0x00000100, dtsListTabDelimit = 0x200, dtsListIndexIncludeDocId = 0x400, dtsListIndexIncludeDocCount = 0x800, dtsListIndexIncludeDocInfoAsXml = 0x1000, dtsListIndexSkipNoiseWords = 0x2000, dtsListIndexFieldValues = 0x4000 }; 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; }; enum CheckConfigurationFlags { dtsCcfCheckDefault = 0x0f, dtsCcfCheckAlphabetFile = 1, dtsCcfCheckCmapFiles = 2, dtsCcfCheckStemmingRules = 4, dtsCcfCheckICU = 8, dtsCcfCheckWordNet = 0x10, dtsCcfCheckUserThesaurus = 0x20, dtsCcfCheckFileTypeTableFile = 0x40, dtsCcfCheckTextFieldsFile = 0x80, dtsCcfCheckSegmentationRulesFile = 0x100, dtsCcfCheckNoiseWordsFile = 0x200 }; class dtsSearchResults; class dtsJobOptions; class dtsSearchFilter; class dtsOptionsReader; };

dtsFileConvertJob provides an easy way to display retrieved files in a web browser, web browser control, or other viewer with hits highlighted. If an array of hit offsets is included, these hits will be highlighted using the beforeHit and afterHit markers in the output document. The header and footer markers will appear at the beginning and end of the output file. Output can go to a disk file (outputFile), a memory buffer (outputBuf) or a callback function (pOutputFn). Input can come from a disk file (inputFile) or from a dtsInputStream (inputSource).

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