Search.getCollectionsInfo (Method)

Returns zero or more structures, each containing information on a search collection and its status.

Returns:

Search_GetCollectionsInfo_Result (query)

Each row of the returned query results has the following fields:

Field Name Type Description
Directory PlainText Obsolete - to defunct.
ErrorReason PlainText If the 'Status' member's value is 'FAIL', this is the reason for the failure. An empty string indicates that no failure occurred.
Name PlainText Name of full-text collection.
NumberOfItemsIndexed NonNegativeInteger The number of items indexed in this collection.
Status Any The collection's status.
SubsiteCount NonNegativeInteger The number of subsites in this collection.

Context:

License Requirements Search
Permission Requirements ContributorOrServerCode
Deny Context None
Require Context None
Author Lock (not required)
Transaction Logging Transaction logging is disabled for this method
Customization This method may be customized at the site level

Error Codes:

None

Notes:

None