AdminIndexServer

The AdminIndexServer object manages the indexing service itself, including the collection of catalogs that identify the documents to be indexed. This object also provides methods to detect whether the indexing service is currently running and to start and stop it programmatically.

Property namesTypeAccessDescription
MachineNameStringRead/
write
Name of Indexing Service machine.

Write once only.


Methods
Method namesDescription
AddCatalogCreates a new catalog.
ContinueContinues Indexing Service.
EnableCIEnable Indexing Service to start automatically.
FindFirstCatalogInitializes catalog enumeration. TRUE if a catalog exists and can be retrieved.
FindNextCatalogEnumerates the next catalog. TRUE if next catalog exists and can be retrieved.
GetCatalogRetrieves the current catalog during an enumeration.
GetCatalogByNameRetrieves a catalog object by name.
GetLongPropertyRetrieves a content index registry value of type REG_DWORD, as described in Registry Entries. Accessed as type Long in Visual Basic.
GetSZPropertyRetrieves a content index registry value of type String REG_SZ, as described in Registry Entries. Accessed as type String in Visual Basic.
IsPausedChecks to see whether Indexing Service is paused.
IsRunningDetermines whether Indexing
Service is running.
PausePauses Indexing Service.
RemoveCatalogRemoves an existing catalog.
SetLongPropertySets a content index registry value of type Long (REG_DWORD) as described in Registry Entries.
SetSZPropertyRetrieves a content index registry value of type String (REG_SZ) as described in Registry Entries.
StartStarts Indexing Service.
StopStops Indexing Service.

Remarks

Although you can manage many aspects of Indexing Service while it is running, you must stop the service to create catalogs with the AddCatalog method or delete catalogs with RemoveCatalog. To determine whether Indexing Service is running, use IsRunning. To stop the service, use the Stop method, make any additions or deletions necessary, and begin the service again using the Start method. Additional information about configuring catalogs can be found through the Help command on the Start menu on the main taskbar under the topic Other Tools.

If multiple instances of the AdminIndexServer object are created, changes made to one instance do not propagate to the other running instances. For example, if you have two instances of the AdminIndexServer object running and invoke the AddCatalog method of one object, the other AdminIndexServer object doesn't know about the newly added catalog. New instances of this object are created with the most current information.

The programmatic identifier (ProgID) in the registry under HKEY_LOCAL_MACHINE/Software/Classes for the administration object in ciodm.dll is Microsoft.ISAdm.1. The version-independent ProgID is Microsoft.ISAdm. The Indexing Service administration object implementation is enabled for apartment and free threading.

This object supports IErrorInfo to report errors.

Registry entries currently in use by Indexing Service can be found under HKEY_LOCAL_MACHINE/System/CurrentControlSet/Control/ContentIndex.

Example
Set objISAdmin = CreateObject("Microsoft.ISAdm") 
Requirements

  Microsoft Windows 2000 or later: Requires Windows 2000 or later.

  Import Library: Included as a resource in ciodm.dll.

See Also

Secure Code Practices

 

Page view tracker