dtsExtractionOptions Structure

dtsExtractionOptions (attached to a dtsFileConvertJob2) specifies how embedded images and attachments should be handled.

File

File: dtsearch.h

Syntax

C++

struct dtsExtractionOptions { int flags; const char * outputLocation; const char * outputReference; const char * outputFileListName; const char * filenamePrefix; const char * unnamedAttachmentLinkText; const char * allowedExtensions; const char * defaultExtension; };

Data Members

Data Member	Description
allowedExtensions	If the dtsExoLimitExtensions flag is set, image and attachment filename extensions will be limited to the values listed in allowedExtensions.
defaultExtension	Extension to add to images and attachments when the dtsExoLimitExtensions flag is set and an image or attachment has an extension that is not listed in allowedExtensions.
filenamePrefix	Filename prefix for extracted files stored in outputLocation
flags	ExtractionOptionsFlags value.
outputFileListName	Name of text file to create with the names of all images and attachments extracted to the outputLocation.
outputLocation	Output folder for images and attachments extracted from the input file
outputReference	URL of the outputLocation for links in the conversion output.
unnamedAttachmentLinkText	Text to use for link to an attachment that has no name

Group

Classes

Members

Data Members

Data Member	Description
allowedExtensions	If the dtsExoLimitExtensions flag is set, image and attachment filename extensions will be limited to the values listed in allowedExtensions.
defaultExtension	Extension to add to images and attachments when the dtsExoLimitExtensions flag is set and an image or attachment has an extension that is not listed in allowedExtensions.
filenamePrefix	Filename prefix for extracted files stored in outputLocation
flags	ExtractionOptionsFlags value.
outputFileListName	Name of text file to create with the names of all images and attachments extracted to the outputLocation.
outputLocation	Output folder for images and attachments extracted from the input file
outputReference	URL of the outputLocation for links in the conversion output.
unnamedAttachmentLinkText	Text to use for link to an attachment that has no name

Methods

Method	Description
clear	Clear all data
copy	Copy another dtsExtractionOptions (shallow copy)
dtsExtractionOptions	Constructor

Methods

Method	Description
clear	Clear all data
copy	Copy another dtsExtractionOptions (shallow copy)
dtsExtractionOptions	Constructor

Remarks

During conversion, embedded images and attachments can be extracted to a folder, with links to the extracted images and attachments inserted in the output.

When highlighting hits, flags should be consistent with the behavior of the indexer or hit highlighting will be inconsistent.

dtsExoExtractAttachments should not be used when highlighting hits because in some cases text is added to the conversion output to provide a location for the link to the extracted attachment.

dtsExoDoNotConvertAttachments should not be used when highlighting hits because the indexer does convert attachments to text.

dtsExoExtractImages can be used when highlighting hits.