Links
dtSearch Text Retrieval Engine Programmer's Reference 7.70
dtsIndexCache::closeIndex Method
dtsIndexCache Class | dtsIndexCache Class | dtSearch Namespace | Send Feedback

Close all indexes in a cache that match a filename or filename pattern including wildcards

bool closeIndex(const char * filenamePattern);
Parameters
Parameters 
Description 
const char * filenamePattern 
Filename or filename pattern to match. The filename pattern may include the wildcards * and ?. The match is case-insensitive. 
Returns

Returns true if either (a) the index was not present in the cache, or (b) all instances of the index in the cache could be closed

Remarks

CloseIndex() will attempt to close all instances of an index in the cache. If an instance is currently being used in a search, the attempt will fail and closeIndex() will return false. After closeIndex() returns, the index may be reopened if a search that uses the cache references the index. Therefore, before calling closeIndex(), an application should ensure that the code that initiates searches will not cause the index to be reopened.

Class
Links
You are here: C++ API > Classes > dtsIndexCache Class > dtsIndexCache::closeIndex Method
Copyright (c) 1995-2012 dtSearch Corp. All rights reserved.