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

File: dtsearch.h

enum ConvertFlags { dtsConvertInputIsHtml = 0x0001, dtsConvertSkipHiddenHits = 0x0002, dtsConvertRemoveScripts = 0x0004, dtsConvertInputIsNotHtml = 0x0008, dtsConvertExtractOnly = 0x0020, dtsConvertXmlToXml = 0x0040, dtsConvertJustDetectType = 0x0080, dtsConvertUseStyles = 0x0100, dtsConvertGetFromCache = 0x2000, dtsConvertInlineContainer = 0x4000, dtsConvertAutoUpdateSearch = 0x20000, dtsConvertIncludeBOM = 0x40000, dtsConvertMultiHighlight = 0x80000 };
dtsConvertInputIsHtml = 0x0001
dtsConvertSkipHiddenHits = 0x0002
Do not insert BeforeHit and AfterHit marks for a hit that cannot be displayed in HTML because the text is not visible. If this flag is not set, a pair of beforeHit/afterHit tags will be added before the next visible text in the file.
dtsConvertRemoveScripts = 0x0004
Remove JavaScript from HTML files when adding hit highlight markings. JavaScript in HTML files can cause errors if displayed outside of the expected context of the script.
dtsConvertInputIsNotHtml = 0x0008
dtsConvertExtractOnly = 0x0020
Extract a document either from an index or from a container
dtsConvertXmlToXml = 0x0040
Add hit highlight markings to XML data while retaining the XML format. Both the input and output formats must be XML. See Highlighting hits in XML files in the dtSearch Engine Programmer's Reference (dtSearchApiRef.chm) for information on this flag.
dtsConvertJustDetectType = 0x0080
Just detect the file type of the document and return it in detectedTypeId, without generating any output.
dtsConvertUseStyles = 0x0100
Use CSS styles instead of inline formatting to format HTML output. This affects content such as email headers, document properties, attachment filenames, and other content that does not have its own formatting from the document. See Conversion output formatting in the dtSearch Engine Programmer's Reference (dtSearchApiRef.chm) for information on this flag.
dtsConvertGetFromCache = 0x2000
Read input file from cached document stored in the index.
dtsConvertInlineContainer = 0x4000
If the input is a container (such as a ZIP file), recursively unpack each item in the container, convert it, and append it to the output. dtsConvertInlineContainer is ignored if the input file is not a container, so it has no effect on the processing of .doc, .xls, etc. files.
dtsConvertAutoUpdateSearch = 0x20000
Automatically update hit offsets if this document was indexed by an earlier version of dtSearch or was changed since it was last indexed. When using this flag, SetInputItem() must be used to transfer information about the search from SearchResults. Additionally, the SearchResults must be generated from a search and not by calling UrlDecodeItem, because dtSearch needs information from the original search to ensure that highlighting information is correct.
dtsConvertIncludeBOM = 0x40000
include BOM in UTF-8 output
dtsConvertMultiHighlight = 0x80000
Highlight each search term using different highlighting attributes. See Highlighting each term using different attributes in the dtSearch Engine Programmer's Reference (dtSearchApiRef.chm) for information on this flag.

Flags for dtsConvertJob2 (C++) and FileConverter (.NET, Java)

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