You are here: C++ API > Classes > dtsSearchJob Structure > dtsSearchJob::autoStopLimit Data Member
Close
dtSearch Text Retrieval Engine Programmer's Reference
dtsSearchJob::autoStopLimit Data Member
Syntax
C++
long autoStopLimit;

Set to a non-zero value to make the search automatically stop when this many documents were found. 

AutoStopLimit causes a search to halt automatically when a specified number of documents have been found. This provides a way to limit the resources consumed by searches that retrieve a very large number of documents. When the number of files retrieved reaches the autoStopLimit value, the search will immediately halt, and the code dtsErSearchLimitReached will be returned through the error handler for the search job. If the AutoStopLimit is 0, the search will not halt.