Search.validateNewCollectionInfo (Method)
Validates that the given name is valid as a new collection name. Returns a structure with the results.
Returns:
ValidateCollectionStatus (struct)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| ErrorMessage | PlainText | The reasons why the collection information is invalid. If it is valid, this is an empty string. |
| FullCollectionDirectoryPath | DirectoryPath | If valid, this is the full path to the collection directory. Otherwise, this is en empty string. |
| isValid | Boolean | Boolean flag which when true indicates that the collection information is valid. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| collectionName | CollectionName_NonExisting | Required | Name to validate for use as a new collection name. |
Context:
| License Requirements | FullTextIndex |
| Permission Requirements | anySubsite:SubsiteAdmin |
| 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:
| Code | Error Message |
|---|---|
| 40007 | A collection already exists for parent directory '$1'. |
| 40008 | A collection with name '$1' already exists. |
| 40009 | Cannot create full text search collection '$1'. The directory '$3' already exists. Please delete this directory and try again. |
| 40013 | |
| 40014 | The specified collection ParentDirectory '$1' does not exist. |
Notes:
None