CatAdm

The CatAdm catalog administration object manages a catalog definition for Indexing Service. The catalog defines the set of documents to index by specifying the list of directories that are used by Indexing Service to determine the files to index. Catalog objects can be created only by means of the AddCatalog method on the AdminIndexServer object and can be retrieved in the following ways.

Through the numeration methods FindFirstCatalog and FindNextCatalog on the AdminIndexServer class; or
GetCatalogByName on the AdminIndexServer class.

The properties supported on this object include counters that show the current state of the indexing process.

Use methods defined on the CatAdm object to monitor performance, adjust local parameters, force merges, and add and remove scopes from the catalog.

Remarks

Access CatAdm objects only through methods defined on the AdminIndexServer object.

This object supports IErrorInfo to report errors.

The following table lists the catalog properties of CatAdm objects. Many of these properties can only be retrieved while Indexing Service is running.

Property names	Type	Access	Description
CatalogLocation	STR	R/O	Case-insensitive path.
CatalogName	STR	R/O	Case-insensitive catalog name.
DelayedFilterCount	LONG	R/O	Count of documents delayed for indexing. This reflects the number of documents that couldn't be indexed during a previous pass for various reasons, such as sharing violations.
DocumentsToFilter	LONG	R/O	Number of documents to index.
FilteredDocumentCount	LONG	R/O	Number of documents indexed since the last time Indexing Service started.
FreshTestCount	LONG	R/O	FOR INTERNAL USE.
IndexSize	LONG	R/O	Total size of the index in megabytes. Includes master and shadow indexes, and the property store.
IsUpToDate	VARIANT_BOOL	R/O	Flag indicating whether index is up to date.
PctMergeComplete	LONG	R/O	Percentage of merge process completed.
PendingScanCount	LONG	R/O	Number of directories to be scanned.
PersistentIndexCount	LONG	R/O	Number of persistent indexes that currently exist.
QueryCount	LONG	R/O	Number of active queries since Indexing Service started.
StateInfo	LONG	R/O	A combination of CI_STATE_* constants reflecting the state of the service.
TotalDocumentCount	LONG	R/O	Total document count in the set of documents to index.
UniqueKeyCount	LONG	R/O	Number of unique keys. Includes existing persistent indexes and nonpersistent wordlists.
WordListCount	LONG	R/O	Number of existing word lists.

Method names	Description
AddScope	Creates a new scope.
ContinueCatalog	Starts the catalog and returns its previous state.
FindFirstScope	Finds the first scope in an enumeration.
FindNextScope	Finds the next scope in an enumeration.
ForceMasterMerge	Begins a master index merge for the catalog.
GetScope	Retrieves current scope object.
GetScopeByAlias	Retrieves scope object by alias name.
GetScopeByPath	Retrieves scope object by path name.
IsCatalogPaused	Checks whether the catalog is in read-only mode.
IsCatalogRunning	Checks whether the catalog is in read/write mode.
IsCatalogStopped	Checks whether the catalog is stopped.
PauseCatalog	Pauses the catalog and returns its previous state.
RemoveScope	Removes an existing scope object from a collection.
StartCatalog	Starts the catalog and returns its previous state.
StopCatalog	Stops the catalog and returns its previous state.

Requirements

Windows 2000 or later: Requires Windows 2000 or later.
Import Library: Included as a resource in ciodm.dll.

Remarks

Requirements

See Also