Search.getCollectionsList (Method)
Returns zero or more structures, each containing information on this site's search collections.
Returns:
Search_GetCollectionsList_Result (query)
Each row of the returned query results has the following fields:
Field Name | Type | Description |
---|---|---|
Name | PlainText_NonNull | The search collection's name. |
Arguments:
Name | Type | Required | Description |
---|---|---|---|
subsiteID | SubsiteID_0 | Optional. Defaults to '0'. | ID of the Subsite or 0 for all subsites. |
includeChildSubsites | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true indicates to include all descendant subsites. |
Context:
License Requirements | (none) |
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