ICatAdm interface
[Indexing Service is no longer supported as of Windows XP and is unavailable for use as of Windows 8. Instead, use Windows Search for client side search and Microsoft Search Server Express for server side search.]
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 by either of the following:
- The enumeration methods FindFirstCatalog and FindNextCatalog on AdminIndexServer
- The GetCatalogByName on AdminIndexServer
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.
Members
The ICatAdm interface inherits from the IDispatch interface. ICatAdm also has these types of members:
Methods
The ICatAdm interface has these methods.
| Method | Description |
|---|---|
| AddScope | Creates a new scope. |
| ContinueCatalog | Starts the catalog and retrieves 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 a scope object by alias name. |
| GetScopeByPath | Retrieves a scope object by path name. |
| IsCatalogPaused | Determines whether the catalog is in read-only mode. |
| IsCatalogRunning | Determines whether the catalog is in read/write mode. |
| IsCatalogStopped | Determines whether the catalog is stopped. |
| PauseCatalog | Pauses the catalog and retrieves its previous state. |
| RemoveScope | Removes an existing scope object from a collection. |
| StartCatalog | Starts the catalog and retrieves its previous state. |
| StopCatalog | Stops the catalog and retrieves its previous state. |
Properties
The ICatAdm interface has these properties.
| Property | Access type | Description |
|---|---|---|
| CatalogLocation |
Read-only |
The case-insentitive path. |
| CatalogName |
Read-only |
The case-insensitive catalog name. |
| DelayedFilterCount |
Read-only |
The number of documents delayed for indexing during a previous pass. Possible reasons for delay include sharing violations. |
| DocumentsToFilter |
Read-only |
The number of documents to be indexed. |
| FilteredDocumentCount |
Read-only |
The number of documents indexed since the last time Indexing Service started. |
| FreshTestCount |
Read-only |
The number of entries in the fresh test list. For internal use only. |
| IndexSize |
Read-only |
The total size of the index, in megabytes. Includes master and shadow indexes, and the property store. |
| IsUpToDate |
Read-only |
Indicates whether the index is up to date. |
| PctMergeComplete |
Read-only |
The percentage of the merge process completed. |
| PendingScanCount |
Read-only |
The number of directories to be scanned. |
| PersistentIndexCount |
Read-only |
The number of persistent indexes that currently exist. |
| QueryCount |
Read-only |
The number of active queries since Indexing Service started. |
| StateInfo |
Read-only |
The state of the service. |
| TotalDocumentCount |
Read-only |
The total document count in the set of documents to be indexed. |
| UniqueKeyCount |
Read-only |
The number of unique keys. Includes existing persistent indexes and nonpersistent wordlists. |
| WordListCount |
Read-only |
The number of existing word lists. |
Remarks
Access CatAdm objects only through methods defined on the AdminIndexServer object.
This object supports IErrorInfo to report errors.
Requirements
| Minimum supported client |
Windows 2000 Professional [desktop apps only] |
| Minimum supported server |
Windows 2000 Server [desktop apps only] |
| End of client support |
Windows 7 |
| End of server support |
Windows Server 2008 R2 |
| DLL |
|