DFileConvertJob Class

Class wrapper around dtsFileConvertJob2; used to convert files to HTML, RTF, or Ansi text.

class DFileConvertJob : public DOutputBase;

File

dtsfc.h

Remarks

DFileConvertJob provides an easy way to display retrieved files in a web browser, web browser control, or other viewer with hits highlighted.

When working with search results, the recommended way to set up DFileConvertJob is to use SetInputItem, which automatically sets up the DFileConvertJob based on data in the search results object.

If a list of hits is provided, 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 (SetOutputToFile), a memory buffer (SetOutputToString) or a callback function (SetOutputToCallback). Input can come from a disk file (InputFile) or from a memory buffer (SetInputText).

See the DJobBase base class for execution control functions (Cancel(), GetErrors(), etc.) common to the C++ support classes.

Data Members

DOutputBase Class

Data Member	Description
AfterHit	Text inserted after each hit
BeforeHit	Text inserted before each hit
Footer	Text inserted at the end of the file
Header	Text inserted at the start of the file
HtmlBaseHref	For HTML output, an HREF for a BASE tag to be inserted in the header.
HtmlHead	For HTML output, HTML tags to insert in the header
OutputFile	Name of file to create, if the output is to be written to a file.

DFileConvertJob Class

Data Member	Description
AlphabetLocation	The location of the dtSearch alphabet file to use when highlighting hits.
IndexRetrievedFrom	The index in which the document was found.
InputFile	Input file to be converted

Group

Classes

Methods

Method	Description
Cancel	Requests termination of the job in progress.
CancelImmediate	Requests immediate termination of the job in progress.
Execute	Called to execute a job.
Failed	Returns non-zero if the job failed
FormatErrors	Format all errors that occurred during execution as a single string, with line breaks separating the errors
GetErrorCount	Returns the number of errors recorded during execution
GetErrors	Returns a dtsErrorInfo with any errors that occurred during execution
IsCancelled	Returns true if the job has been cancelled
IsRunning	Returns true if the job has started and is not yet done.
OnCheckAbort	Called while a job is executing every time the dtSearch Engine checks to see if the job has been cancelled.
OnError	Called while a job is executing if an error is encountered, with the error code and message.
OnQuestion	Not used
SetTimeout	SetTimeout() causes a job to cancel automatically after the specified number of seconds
SuppressMessagePump	Do not pump waiting windows messages during callbacks

DOutputBase Class

Method	Description
Clear	Clear all fields to default values
Execute	Called to execute a job.
GetOutputString	If output was to a string, returns a pointer to the output string
GetOutputStringLen	Get the length of the output string
IsOutputToString	Returns true if output was directed to a string
OnCheckAbort	Called while a job is executing every time the dtSearch Engine checks to see if the job has been cancelled.
OnError
OnOutput	Callback function to receive output as it is generated
OnPercentDone	Callback function to update the progress of the conversion or search report
SetOutputFormat	Specifies the format of the converted text.
SetOutputToCallback	Send output only to the virtual callback function, OnOutput
SetOutputToFile	Send output to a file
SetOutputToString	Send output to a string buffer managed by the class, and set the maximum length of the output string.

DFileConvertJob Class

Method	Description
Execute	Execute the job
GetDetectedTypeId	The file type of the input document, as detected by the dtSearch file parsers during the conversion
GetFlags	Returns the ConvertFlags for the job
GetInputDocId	Returns the document id for the document in the index it was retrieved from.
GetTypeId	The file type of the input document when it was indexed.
SetFlag	Set a ConvertFlags value for this job
SetFlags	Set ConvertFlags for this job
SetHits	Set the word offsets of hits to highlight.
SetIndexedBy	Set the build number used to index this file for purposes of maintaining backward compatibility (this will eliminate some compatibility issues but not all).
SetInputFlags	! Reserved for internal use
SetInputItem	This is the overview for the SetInputItem method overload.
SetInputSource	! obsolete -- use SetInputStream
SetInputStream	DFileConvertJob can get input from a file, a memory buffer, or from a dtsInputStream. Use SetInputStream to attach a dtsInputStream to use as input.
SetInputText	This is the overview for the SetInputText method overload.
SetTypeId	The file type of the input document when it was indexed.

Legend

	Method
	virtual
	abstract
	Data Member

Links

Data Members, Classes, Legend, Members, Methods, SetInputItem Method, SetInputText Method