dtsFileConvertJob2 Structure

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

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;
};

File

dtsearch.h

Remarks

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).

Data Members

dtsFileConvertJob2 Structure

Data Member	Description
alphabetLocation	The location of the dtSearch alphabet file to use when highlighting hits.
detectedTypeId	File type of input document detected by dtSearch file parsers.
docId	Document id of this document in the index it was found in.
encodedSearchItem	Encoded version of search request that found this document String generated by urlEncodeItem with dtsUrlEncodeAsSearch
extractionOptions	Options for extraction of embedded images and attachments
flags	ConvertFlags specifying how the conversion should be performed
hitCount	Number of hits to be highlighted
hits	Word offsets of the hits to be highlighted (usually from dtsSearchResultsItem.hits)
indexedBy	The build number of dtSearch that was used to index this file.
indexRetrievedFrom	Path of the index this document was found in
inputFile	Name of the input file to highlight.
inputSource	A dtsInputStream that will return the document to be converted.
output	Specification for the output format and destination (file, memory buffer, or callback)
typeId	Type id of the file parser to use to convert this file.

Group

Classes

Methods

dtsFileConvertJob2 Structure

Method	Description
dtsFileConvertJob2	Constructor

Legend

	Data Member
	Constructor

Links

Data Members, Classes, Legend, Members, Methods