DOutputBase Class

Class wrapper around dtsOutputInfo, which is used in DSearchReportJob and DFileConvertJob to specify the output format for file conversion and search reports

File

File: dtsfc.h

Namespace: dtSearch

Syntax

C++

class DOutputBase : public DJobBase;

Data Members

Data Member	Description
AfterHit	Text inserted after each hit
BeforeHit	Text inserted before each hit
DocTypeTag	For HTML output, a doctype declaration to go at the top of the output
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.

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
Execute	Called to execute a job. (Inherited from DJobBase)
Execute	Called to execute a job.
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)
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)
GetOutputString	If output was to a string, returns a pointer to the output string
GetOutputStringLen	Get the length of the output string
IsCancelled	Returns true if the job has been cancelled (Inherited from DJobBase)
IsOutputToString	Returns true if output was directed to a string
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.
OnError	Called while a job is executing if an error is encountered, with the error code and message. (Inherited from DJobBase)
OnError
OnOutput	Callback function to receive output as it is generated
OnPercentDone	Callback function to update the progress of the conversion or search report
OnQuestion	Not used (Inherited from DJobBase)
SetOutputFormat	Specifies the format of the converted text. Currently supported options are: it_HTML, it_RTF, it_Utf8 (Unicode text), and it_Ansi.
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.
SetTimeout	SetTimeout() causes a job to cancel automatically after the specified number of seconds (Inherited from DJobBase)
SuppressMessagePump	Do not pump waiting windows messages during callbacks (Inherited from DJobBase)
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

Data Member	Description
AfterHit	Text inserted after each hit
BeforeHit	Text inserted before each hit
DocTypeTag	For HTML output, a doctype declaration to go at the top of the output
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.

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
Execute	Called to execute a job. (Inherited from DJobBase)
Execute	Called to execute a job.
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)
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)
GetOutputString	If output was to a string, returns a pointer to the output string
GetOutputStringLen	Get the length of the output string
IsCancelled	Returns true if the job has been cancelled (Inherited from DJobBase)
IsOutputToString	Returns true if output was directed to a string
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.
OnError	Called while a job is executing if an error is encountered, with the error code and message. (Inherited from DJobBase)
OnError
OnOutput	Callback function to receive output as it is generated
OnPercentDone	Callback function to update the progress of the conversion or search report
OnQuestion	Not used (Inherited from DJobBase)
SetOutputFormat	Specifies the format of the converted text. Currently supported options are: it_HTML, it_RTF, it_Utf8 (Unicode text), and it_Ansi.
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.
SetTimeout	SetTimeout() causes a job to cancel automatically after the specified number of seconds (Inherited from DJobBase)
SuppressMessagePump	Do not pump waiting windows messages during callbacks (Inherited from DJobBase)
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

The header, footer, beforeHit, and afterHit markings should be in the format of the output. For example, if the output format is HTML, then beforeHit and afterHit markings could be <b> and </b>.

BeforeHit, AfterHit, Header, and Footer control the appearance of converted text.

The Header and Footer strings are inserted before and after the body of the document.

The BeforeHit and AfterHit markers are inserted before and after each hit word. The BeforeHit and AfterHit markers can contain hypertext links.

To facilitate creation of hit navigation markers, the strings "%%ThisHit%%", "%%NextHit%%", and "%%PrevHit%%" will be replaced with ordinals representing the current hit, the next hit, and the previous hit in the document.

For example, the following code makes the beforeHit and nextHit marks act as HTML "Previous Hit" and "Next Hit" buttons.

job.BeforeHit = "<A NAME="hit%%ThisHit%%">" "<A HREF="#hit%%PrevHit%%">" "<IMG SRC="hit1.gif" ALIGN="middle" ALT="[Prev Hit]" BORDER=0>"; job.AfterHit = "<A HREF="#hit%%NextHit%%">" "<IMG SRC="hit2.gif" ALIGN="middle" ALT="[Next Hit]" BORDER=0>";

Class Hierarchy

dtSearch::DJobBase | dtSearch::DOutputBase