ISearchJob Interface

File

File: dten600.idl

Module: COM Interface

Syntax

IDL

interface ISearchJob : IDispatch;

Group

Interfaces

Members

Properties

Property	Description
AutoStopLimit	AutoStopLimit causes a search to halt automatically when a specified number of documents have been found.
BooleanConditions	Additional boolean conditions that a document must meet to be retrieved in a search.
DirListName	In an unindexed search, the name of a file containing a list of directories (or filenames) to search.
DirToSearch	In an unindexed search, the directory to search.
Errors	After a search is done, the Errors property will contain a JobErrorInfo (IJobErrorInfo) object with any error messages generated during the indexing job.
ExcludeFilters	A file will be searched if it matches one of the IncludeFilters and does not match any of the ExcludeFilters.
FieldWeights	Specify a relevance weight for hits that occur in listed fields (example: Subject:10,HtmlTitle:20)
FileConditions	File conditions that a document must meet to be retrieved in a search.
FileCount	After a search, contains the number of files retrieved
Fuzziness	If non-zero, the engine will match words that are close to but not identical to a search term. The higher the fuzziness, the more differences the engine will disregard in finding a match. Fuzziness can range from 0 to 10.
HitCount	After a search, contains the number of hits in all files retrieved
IncludeFilters	A file will be searched if it matches one of the IncludeFilters and does not match any of the ExcludeFilters.
IndexesToSearch	List of indexes to search. Deprecated: Use AddIndexToSearch
IsThreadDone	Returns true if a searching thread started by ExecuteInThread has completed.
ListingFlags	ListingFlags specifying the type of listing to generate
MaxFilesToRetrieve	Limit the maximum size of search results to a specified number of files.
OutputListingName	If set to a filename, the name and hitcount of each file retrieved in the search will be written to this file.
Request	Specifies the text to be found. See Search Requests Overview
Results	Copies and returns the results of the search as a SearchResults object
ResultsAsFilter	If WantResultsAsFilter was set to true before the search was executed, ResultsAsFilter will hold a SearchFilter based on the results of the search. Each document retrieved in the search will be selected in the filter.
SearchFlags	SearchFlags specifying the features to use in this search
StatusHandler	The object that will receive status notification messages from the engine while the search is in progress.
TimeoutSeconds	If non-zero, the number of seconds to allow the search to run before automatically cancelling it.
WantResultsAsFilter	If set to true before a search, after the search ResultsAsFilter will contain a SearchFilter with all of the documents retrieved in this search.

Methods

Method	Description
AbortThread	Aborts an indexing thread started by ExecuteInThread.
AddIndexToSearch	Add an index path to the IndexesToSearch string. AddIndexToSearch takes care of adding quotation marks where needed (if an index path contains a space) and should be used instead of directly assigning to IndexesToSearch.
Execute	Performs the search and returns 0 if the search is successful or -1 if an error occured.
ExecuteInThread	ExecuteInThread starts the search in a separate thread and returns immediately.
IsThreadDoneWait	Returns true immediately if the thread is done; otherwise waits up to millisecondsToWait for the thread to finish, then returns false if the thread is not done yet.
SetFilter	Apply a search filter to the search that can be used to exclude or permit specified documents to be returned in search results.
SetIndexCache	Use an IndexCache for this SearchJob

Methods

Method	Description
AbortThread	Aborts an indexing thread started by ExecuteInThread.
AddIndexToSearch	Add an index path to the IndexesToSearch string. AddIndexToSearch takes care of adding quotation marks where needed (if an index path contains a space) and should be used instead of directly assigning to IndexesToSearch.
Execute	Performs the search and returns 0 if the search is successful or -1 if an error occured.
ExecuteInThread	ExecuteInThread starts the search in a separate thread and returns immediately.
IsThreadDoneWait	Returns true immediately if the thread is done; otherwise waits up to millisecondsToWait for the thread to finish, then returns false if the thread is not done yet.
SetFilter	Apply a search filter to the search that can be used to exclude or permit specified documents to be returned in search results.
SetIndexCache	Use an IndexCache for this SearchJob

Properties

Property	Description
AutoStopLimit	AutoStopLimit causes a search to halt automatically when a specified number of documents have been found.
BooleanConditions	Additional boolean conditions that a document must meet to be retrieved in a search.
DirListName	In an unindexed search, the name of a file containing a list of directories (or filenames) to search.
DirToSearch	In an unindexed search, the directory to search.
Errors	After a search is done, the Errors property will contain a JobErrorInfo (IJobErrorInfo) object with any error messages generated during the indexing job.
ExcludeFilters	A file will be searched if it matches one of the IncludeFilters and does not match any of the ExcludeFilters.
FieldWeights	Specify a relevance weight for hits that occur in listed fields (example: Subject:10,HtmlTitle:20)
FileConditions	File conditions that a document must meet to be retrieved in a search.
FileCount	After a search, contains the number of files retrieved
Fuzziness	If non-zero, the engine will match words that are close to but not identical to a search term. The higher the fuzziness, the more differences the engine will disregard in finding a match. Fuzziness can range from 0 to 10.
HitCount	After a search, contains the number of hits in all files retrieved
IncludeFilters	A file will be searched if it matches one of the IncludeFilters and does not match any of the ExcludeFilters.
IndexesToSearch	List of indexes to search. Deprecated: Use AddIndexToSearch
IsThreadDone	Returns true if a searching thread started by ExecuteInThread has completed.
ListingFlags	ListingFlags specifying the type of listing to generate
MaxFilesToRetrieve	Limit the maximum size of search results to a specified number of files.
OutputListingName	If set to a filename, the name and hitcount of each file retrieved in the search will be written to this file.
Request	Specifies the text to be found. See Search Requests Overview
Results	Copies and returns the results of the search as a SearchResults object
ResultsAsFilter	If WantResultsAsFilter was set to true before the search was executed, ResultsAsFilter will hold a SearchFilter based on the results of the search. Each document retrieved in the search will be selected in the filter.
SearchFlags	SearchFlags specifying the features to use in this search
StatusHandler	The object that will receive status notification messages from the engine while the search is in progress.
TimeoutSeconds	If non-zero, the number of seconds to allow the search to run before automatically cancelling it.
WantResultsAsFilter	If set to true before a search, after the search ResultsAsFilter will contain a SearchFilter with all of the documents retrieved in this search.

Description

Performs searches with or without an index.

Remarks

To perform a search, make a SearchJob, use the properties to describe the task you want the engine to perform, and call the Execute() method.

Obtaining Search Results

You can request search results in an in-memory object, a listing file created after a search, or through callbacks sent through the StatusHandler object.

To obtain search results in an in-memory object, sorted by relevance, set the MaxFilesToRetrieve property to the size of the search results object you want. After a search, use the Results property of the SearchJob to access search results, like this:

Dim r as SearchResults Set r = searchJob.Results for i = 0 to r.Count-1 r.GetNthDoc(i) next i

To obtain a text file listing the filenames of retrieved files, supply a filename in OutputListingName.

To obtain an unsorted list of documents as they are retrieved, with hit counts, implement the ReceiveFound callback method in an object attached to the StatusHandler member. To obtain detailed information instead of a simple list of filenames, implement the ReceiveFoundWithDetail callback method. To obtain hit offsets for each document as it is retrieved, implement the ReceiveHits callback method. Because of the overhead associated with implementing callbacks in COM, this method is much slower than using SearchResults.

Use the NewSearchJob method of the Server object to create a new SearchJob object.

Class Hierarchy

ISearchJob