DFileConvertJob Class

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

File

File: dtsfc.h

Namespace: dtSearch

SetInputItem Method
SetInputText Method

Syntax

C++

class DFileConvertJob : public DOutputBase;

Data Members

Show:Inherited

No members matching the current filter

Data Member	Description
AfterHit	Text inserted after each hit (Inherited from DOutputBase)
AlphabetLocation	The location of the dtSearch alphabet file to use when highlighting hits. The alphabet file determines how dtSearch counts words, so it is important that the same alphabet file used to index or search a file also be used to highlight hits. For more information on how hit highlighting works, see Highlighting Hits in the online help. To ensure that the same alphabet used to index a file is used to highlight hits in that file, set the alphabetLocation to the folder where the index is located. The alphabet definition will be stored in this folder (in a file named... more
BeforeHit	Text inserted before each hit (Inherited from DOutputBase)
DocTypeTag	For HTML output, a doctype declaration to go at the top of the output (Inherited from DOutputBase)
Footer	Text inserted at the end of the file (Inherited from DOutputBase)
Header	Text inserted at the start of the file (Inherited from DOutputBase)
HitsByWord	A null-delimited string set containing the data returned by a search when the dtsSearchWantHitsByWord and dtsSearchWantHitDetails search flags are set. This is only used when the flag dtsConvertMultiHighlight is set to use different highlighting strings for each search term.
HtmlBaseHref	For HTML output, an HREF for a BASE tag to be inserted in the header. (Inherited from DOutputBase)
HtmlHead	For HTML output, HTML tags to insert in the header (Inherited from DOutputBase)
IndexRetrievedFrom	The index in which the document was found. SetInputItem will set this based on information in SearchResults.
InputFile	Input file to be converted
OutputFile	Name of file to create, if the output is to be written to a file. (Inherited from DOutputBase)

Group

Classes

Members

Methods

Show:InheritedProtected

No members matching the current filter

Method	Description
Cancel	Requests termination of the job in progress. For indexing jobs, the job will be halted after information in documents already indexed is saved in the index. (Inherited from DJobBase)
CancelImmediate	Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. (Inherited from DJobBase)
CancelImmediateWithReason	Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. The reason parameter is purely for diagnostic purposes. (Inherited from DJobBase)
CancelWithReason	Requests termination of the job in progress. For indexing jobs, the job will be halted after information in documents already indexed is saved in the index. The reason parameter is purely for diagnostic purposes. (Inherited from DJobBase)
Clear	Clear all fields to default values (Inherited from DOutputBase)
Execute	Execute the job
Execute	Called to execute a job. (Inherited from DJobBase)
Execute	Called to execute a job. (Inherited from DOutputBase)
Failed	Returns non-zero if the job failed (Inherited from DJobBase)
FormatErrors	Format all errors that occurred during execution as a single string, with line breaks separating the errors (Inherited from DJobBase)
GetDetectedTypeId	The file type of the input document, as detected by the dtSearch file parsers during the conversion
GetErrorCount	Returns the number of errors recorded during execution (Inherited from DJobBase)
GetErrors	Returns a dtsErrorInfo with any errors that occurred during execution (Inherited from DJobBase)
GetFlags	Returns the ConvertFlags for the job
GetInputDocId	Returns the document id for the document in the index it was retrieved from. (This must have been previously set either using SetInputItem or SetInputDocId).
GetOutputString	If output was to a string, returns a pointer to the output string (Inherited from DOutputBase)
GetOutputStringLen	Get the length of the output string (Inherited from DOutputBase)
GetTypeId	The file type of the input document when it was indexed. SetInputItem() will set this based on information in search results.
IsCancelled	Returns true if the job has been cancelled (Inherited from DJobBase)
IsOutputToString	Returns true if output was directed to a string (Inherited from DOutputBase)
IsRunning	Returns true if the job has started and is not yet done. (Inherited from DJobBase)
OnCheckAbort	Called while a job is executing every time the dtSearch Engine checks to see if the job has been cancelled. (Inherited from DJobBase)
OnCheckAbort	Called while a job is executing every time the dtSearch Engine checks to see if the job has been cancelled. (Inherited from DOutputBase)
OnError	Called while a job is executing if an error is encountered, with the error code and message. (Inherited from DJobBase)
OnError	(Inherited from DOutputBase)
OnOutput	Callback function to receive output as it is generated (Inherited from DOutputBase)
OnPercentDone	Callback function to update the progress of the conversion or search report (Inherited from DOutputBase)
OnQuestion	Not used (Inherited from DJobBase)
SetFlag	Set a ConvertFlags value for this job
SetFlags	Set ConvertFlags for this job
SetHits	Set the word offsets of hits to highlight. SetInputItem will set this based on information in search results.
SetIndexCache	Use an IndexCache for faster extraction of cached documents from indexes
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(DSearchResults&, int)	SetInputItem initializes a DFileConvertJob with information about a document that is available from search results.
SetInputItem(const dtsSearchResultsItem&)	SetInputItem initializes a DFileConvertJob with information about a document that is available from search results.
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(const char , const char , int)	Sets the input text to be converted, for conversion of a memory buffer instead of a disk file. The text must be a simple null-terminated string.
SetInputText(const char , ptrdiff_t, const char , int)	Sets the input text to be converted, for conversion of a memory buffer instead of a disk file. The text must be a simple null-terminated string.
SetOutputFormat	Specifies the format of the converted text. Currently supported options are: it_HTML, it_RTF, it_Utf8 (Unicode text), and it_Ansi. (Inherited from DOutputBase)
SetOutputToCallback	Send output only to the virtual callback function, OnOutput (Inherited from DOutputBase)
SetOutputToFile	Send output to a file (Inherited from DOutputBase)
SetOutputToString	Send output to a string buffer managed by the class, and set the maximum length of the output string. (Inherited from DOutputBase)
SetTimeout	SetTimeout() causes a job to cancel automatically after the specified number of seconds (Inherited from DJobBase)
SetTypeId	The file type of the input document when it was indexed. SetInputItem() will set this based on information in search results.
SuppressMessagePump	Do not pump waiting windows messages during callbacks (Inherited from DJobBase)
WasTruncated	Conversion succeeded, but output truncated because of outputInfo.maxOutputLength
addCancelReason	Optional reason for job cancellation, purely for diagnostic purposes Checks to make sure the reason is not already present, and also guards against excessive string size in case of repetitive cancellations. (Inherited from DJobBase)
reportError	Write an error message to the error handler object attached to this job (Inherited from DJobBase)

Data Members

Show:Inherited

No members matching the current filter

Data Member	Description
AfterHit	Text inserted after each hit (Inherited from DOutputBase)
AlphabetLocation	The location of the dtSearch alphabet file to use when highlighting hits. The alphabet file determines how dtSearch counts words, so it is important that the same alphabet file used to index or search a file also be used to highlight hits. For more information on how hit highlighting works, see Highlighting Hits in the online help. To ensure that the same alphabet used to index a file is used to highlight hits in that file, set the alphabetLocation to the folder where the index is located. The alphabet definition will be stored in this folder (in a file named... more
BeforeHit	Text inserted before each hit (Inherited from DOutputBase)
DocTypeTag	For HTML output, a doctype declaration to go at the top of the output (Inherited from DOutputBase)
Footer	Text inserted at the end of the file (Inherited from DOutputBase)
Header	Text inserted at the start of the file (Inherited from DOutputBase)
HitsByWord	A null-delimited string set containing the data returned by a search when the dtsSearchWantHitsByWord and dtsSearchWantHitDetails search flags are set. This is only used when the flag dtsConvertMultiHighlight is set to use different highlighting strings for each search term.
HtmlBaseHref	For HTML output, an HREF for a BASE tag to be inserted in the header. (Inherited from DOutputBase)
HtmlHead	For HTML output, HTML tags to insert in the header (Inherited from DOutputBase)
IndexRetrievedFrom	The index in which the document was found. SetInputItem will set this based on information in SearchResults.
InputFile	Input file to be converted
OutputFile	Name of file to create, if the output is to be written to a file. (Inherited from DOutputBase)

Methods

Show:InheritedProtected

No members matching the current filter

Method	Description
Cancel	Requests termination of the job in progress. For indexing jobs, the job will be halted after information in documents already indexed is saved in the index. (Inherited from DJobBase)
CancelImmediate	Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. (Inherited from DJobBase)
CancelImmediateWithReason	Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. The reason parameter is purely for diagnostic purposes. (Inherited from DJobBase)
CancelWithReason	Requests termination of the job in progress. For indexing jobs, the job will be halted after information in documents already indexed is saved in the index. The reason parameter is purely for diagnostic purposes. (Inherited from DJobBase)
Clear	Clear all fields to default values (Inherited from DOutputBase)
Execute	Execute the job
Execute	Called to execute a job. (Inherited from DJobBase)
Execute	Called to execute a job. (Inherited from DOutputBase)
Failed	Returns non-zero if the job failed (Inherited from DJobBase)
FormatErrors	Format all errors that occurred during execution as a single string, with line breaks separating the errors (Inherited from DJobBase)
GetDetectedTypeId	The file type of the input document, as detected by the dtSearch file parsers during the conversion
GetErrorCount	Returns the number of errors recorded during execution (Inherited from DJobBase)
GetErrors	Returns a dtsErrorInfo with any errors that occurred during execution (Inherited from DJobBase)
GetFlags	Returns the ConvertFlags for the job
GetInputDocId	Returns the document id for the document in the index it was retrieved from. (This must have been previously set either using SetInputItem or SetInputDocId).
GetOutputString	If output was to a string, returns a pointer to the output string (Inherited from DOutputBase)
GetOutputStringLen	Get the length of the output string (Inherited from DOutputBase)
GetTypeId	The file type of the input document when it was indexed. SetInputItem() will set this based on information in search results.
IsCancelled	Returns true if the job has been cancelled (Inherited from DJobBase)
IsOutputToString	Returns true if output was directed to a string (Inherited from DOutputBase)
IsRunning	Returns true if the job has started and is not yet done. (Inherited from DJobBase)
OnCheckAbort	Called while a job is executing every time the dtSearch Engine checks to see if the job has been cancelled. (Inherited from DJobBase)
OnCheckAbort	Called while a job is executing every time the dtSearch Engine checks to see if the job has been cancelled. (Inherited from DOutputBase)
OnError	Called while a job is executing if an error is encountered, with the error code and message. (Inherited from DJobBase)
OnError	(Inherited from DOutputBase)
OnOutput	Callback function to receive output as it is generated (Inherited from DOutputBase)
OnPercentDone	Callback function to update the progress of the conversion or search report (Inherited from DOutputBase)
OnQuestion	Not used (Inherited from DJobBase)
SetFlag	Set a ConvertFlags value for this job
SetFlags	Set ConvertFlags for this job
SetHits	Set the word offsets of hits to highlight. SetInputItem will set this based on information in search results.
SetIndexCache	Use an IndexCache for faster extraction of cached documents from indexes
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(DSearchResults&, int)	SetInputItem initializes a DFileConvertJob with information about a document that is available from search results.
SetInputItem(const dtsSearchResultsItem&)	SetInputItem initializes a DFileConvertJob with information about a document that is available from search results.
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(const char , const char , int)	Sets the input text to be converted, for conversion of a memory buffer instead of a disk file. The text must be a simple null-terminated string.
SetInputText(const char , ptrdiff_t, const char , int)	Sets the input text to be converted, for conversion of a memory buffer instead of a disk file. The text must be a simple null-terminated string.
SetOutputFormat	Specifies the format of the converted text. Currently supported options are: it_HTML, it_RTF, it_Utf8 (Unicode text), and it_Ansi. (Inherited from DOutputBase)
SetOutputToCallback	Send output only to the virtual callback function, OnOutput (Inherited from DOutputBase)
SetOutputToFile	Send output to a file (Inherited from DOutputBase)
SetOutputToString	Send output to a string buffer managed by the class, and set the maximum length of the output string. (Inherited from DOutputBase)
SetTimeout	SetTimeout() causes a job to cancel automatically after the specified number of seconds (Inherited from DJobBase)
SetTypeId	The file type of the input document when it was indexed. SetInputItem() will set this based on information in search results.
SuppressMessagePump	Do not pump waiting windows messages during callbacks (Inherited from DJobBase)
WasTruncated	Conversion succeeded, but output truncated because of outputInfo.maxOutputLength
addCancelReason	Optional reason for job cancellation, purely for diagnostic purposes Checks to make sure the reason is not already present, and also guards against excessive string size in case of repetitive cancellations. (Inherited from DJobBase)
reportError	Write an error message to the error handler object attached to this job (Inherited from DJobBase)

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.

Class Hierarchy

dtSearch::DJobBase | dtSearch::DOutputBase | dtSearch::DFileConvertJob