dten600.idl

Use a SearchReportJob to generate a search report from some or all of the items listed in a SearchResults object.

To create a SearchReportJob,

1. Call the SearchResults object's NewSearchReportJob method (see ISearchResults),
2. Set up the properties of the SearchReportJob to reflect the format of the report you want to create, and
3. Call the Execute method of the SearchReportJob to create the report.

For sample code, see frmMakeReport in the vbsearch sample application.

A search report lists the hits found in one or more documents, with each hit surrounded by a specified amount of context. Each block of context starts with a contextHeader and ends with the contextFooter. Contiguous or overlapping blocks of context will be combined. The amount of context included in the report can be specified by words or by paragraphs. 

Each block of context is constructed as follows:

    [ContextHeader]
    ...text... [BeforeHit] hit [AfterHit] ...text...
    [ContextFooter]

The report as a whole is constructed as follows:

    [Header]
        [FileHeader]
            [ContextHeader]
            ...text... [BeforeHit] hit [AfterHit] ...text...
            [ContextFooter]
            [ContextHeader]
            ...text... [BeforeHit] hit [AfterHit] ...text...
            [ContextFooter]
            ... more blocks of context, if present
        [FileFooter]
        ... more files ...
    [Footer]

Use the following symbols to insert file information into the FileHeader and FileFooter:

Use the following symbols to insert context information in the contextHeader, which appears in front of each block of context:

Use %% around each symbol, like this: %%FullName%%

Interfaces