diff --git a/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/copy-file/copy-files-block.md b/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/copy-file/copy-files-block.md index 5d6b42de9..e68253c7e 100644 --- a/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/copy-file/copy-files-block.md +++ b/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/copy-file/copy-files-block.md @@ -146,8 +146,8 @@ The exceptions thrown by the block can be found below: | | The [Destination Path][DestinationPath Property] contains leading spaces. | | | The [Destination Path][DestinationPath Property] contains only whitespace, or the NUL character (i.e. `\0`), or contains one or more invalid characters (i.e. `"`, `*`, `?`, `\|`, `<`, `>`, `:`, `\`, `/`) in any file or folder names. | | | The [Destination Path][DestinationPath Property] (if it points to a file), or the [Destination Path][DestinationPath Property] (if it points to a folder) plus the file name, exceeds the system-defined maximum length (typically 32,767 characters). | -| [OperationFailedException][] | Any file path in [File Paths][FilePaths Property] is `null` or empty (i.e. `""`). For more information, see [Null or Empty File Paths][]| -| | Any file path in [File Paths][FilePaths Property] is duplicated. For more information, see [Duplicate File Paths][] | +| [OperationFailedException][] | Any file path in [File Paths][FilePaths Property] is `null` or empty (i.e. `""`). | +| | Any file path in [File Paths][FilePaths Property] is duplicated. | | | Any file path in [File Paths][FilePaths Property] does not exist. | | | Any file path in [File Paths][FilePaths Property] points to a folder. | | | Any file path in [File Paths][FilePaths Property] contains leading spaces. | @@ -198,8 +198,6 @@ If an exception occurs when trying to copy a file in the [File Paths][FilePaths [InvalidPathException]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.InvalidPathException.MainDoc" >}} [OperationFailedException]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.MainDoc" >}} -[Duplicate File Paths]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.IndexesOfDuplicatePaths" >}} -[Null Or Empty File Paths]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.IndexesOfNullOrEmptyPaths" >}} [PropertyEmptyException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyEmptyException.MainDoc" >}} [PropertyNullException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyNullException.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/copy-folder/copy-folders-block.md b/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/copy-folder/copy-folders-block.md index 4c28f4f99..0d933eab6 100644 --- a/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/copy-folder/copy-folders-block.md +++ b/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/copy-folder/copy-folders-block.md @@ -406,8 +406,8 @@ The exceptions thrown by the block can be found below: | | The [Destination Path][DestinationPath Property] contains leading spaces. | | | The [Destination Path][DestinationPath Property] contains only whitespace, or the NUL character (i.e. `\0`), or contains one or more invalid characters (i.e. `"`, `*`, `?`, `\|`, `<`, `>`, `:`, `\`, `/`) in any folder names. | | | The [Destination Path][DestinationPath Property] exceeds the system-defined maximum length (typically 32,767 characters). | -| [OperationFailedException][] | Any folder path in [Folder Paths][FolderPaths Property] is `null` or empty (i.e. `""`). For more information, see [Null or Empty Folder Paths][]| -| | Any folder path in [Folder Paths][FolderPaths Property] is duplicated. For more information, see [Duplicate Folder Paths][] | +| [OperationFailedException][] | Any folder path in [Folder Paths][FolderPaths Property] is `null` or empty (i.e. `""`). | +| | Any folder path in [Folder Paths][FolderPaths Property] is duplicated. | | | Any folder path in [Folder Paths][FolderPaths Property] does not exist. | | | Any folder path in [Folder Paths][FolderPaths Property] points to a file. | | | Any folder path in [Folder Paths][FolderPaths Property] contains leading spaces. | @@ -476,8 +476,6 @@ If an exception occurs when trying to copy a folder in [Folder Paths][FolderPath [InvalidPathException]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.InvalidPathException.MainDoc" >}} [OperationFailedException]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.MainDoc" >}} -[Duplicate Folder Paths]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.IndexesOfDuplicatePaths" >}} -[Null Or Empty Folder Paths]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.IndexesOfNullOrEmptyPaths" >}} [PropertyEmptyException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyEmptyException.MainDoc" >}} [PropertyNullException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyNullException.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/create-folder/create-folders-block.md b/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/create-folder/create-folders-block.md index f7e631cfb..0cf8d0e22 100644 --- a/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/create-folder/create-folders-block.md +++ b/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/create-folder/create-folders-block.md @@ -60,8 +60,8 @@ The exceptions thrown by the block can be found below: | Name | Description | |----------|----------| -| [OperationFailedException][] | Any folder path in [Folder Paths][FolderPaths Property] is `null` or empty (i.e. `""`). For more information, see [Null or Empty Folder Paths][]. | -| | Any folder path in [Folder Paths][FolderPaths Property] is duplicated. For more information, see [Duplicate Folder Paths][]. | +| [OperationFailedException][] | Any folder path in [Folder Paths][FolderPaths Property] is `null` or empty (i.e. `""`). | +| | Any folder path in [Folder Paths][FolderPaths Property] is duplicated. | | | Any folder path in [Folder Paths][FolderPaths Property] points to a file. | | | Any folder path in [Folder Paths][FolderPaths Property] contains leading spaces. | | | Any folder path in [Folder Paths][FolderPaths Property] contains only whitespace, or the NUL character (i.e. `\0`), or contains one or more invalid characters (i.e. `"`, `*`, `?`, `\|`, `<`, `>`, `:`, `\`, `/`) in any folder names. | @@ -100,8 +100,6 @@ If an exception occurs when trying to create a folder in [Folder Paths][FolderPa [Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} [OperationFailedException]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.MainDoc" >}} -[Duplicate Folder Paths]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.IndexesOfDuplicatePaths" >}} -[Null Or Empty Folder Paths]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.IndexesOfNullOrEmptyPaths" >}} [PropertyEmptyException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyEmptyException.MainDoc" >}} [PropertyNullException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyNullException.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/delete-file/delete-files-block.md b/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/delete-file/delete-files-block.md index 794ab5a9a..1fbe76dfe 100644 --- a/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/delete-file/delete-files-block.md +++ b/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/delete-file/delete-files-block.md @@ -60,8 +60,8 @@ The exceptions thrown by the block can be found below: | Name | Description | |----------|----------| -| [OperationFailedException][] | Any file path in [File Paths][FilePaths Property] is `null` or empty (i.e. `""`). For more information, see [Null or Empty File Paths][]. | -| | Any file path in [File Paths][FilePaths Property] is duplicated. For more information, see [Duplicate File Paths][]. | +| [OperationFailedException][] | Any file path in [File Paths][FilePaths Property] is `null` or empty (i.e. `""`). | +| | Any file path in [File Paths][FilePaths Property] is duplicated. | | | Any file path in [File Paths][FilePaths Property] points to a folder. | | | Any file path in [File Paths][FilePaths Property] contains leading spaces. | | | Any file path in [File Paths][FilePaths Property] contains only whitespace, or the NUL character (i.e. `\0`), or contains one or more invalid characters (i.e. `"`, `*`, `?`, `\|`, `<`, `>`, `:`, `\`, `/`) in any file or folder names. | @@ -103,8 +103,6 @@ If an exception occurs when trying to delete a file in the [File Paths][FilePath [Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} [OperationFailedException]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.MainDoc" >}} -[Duplicate File Paths]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.IndexesOfDuplicatePaths" >}} -[Null Or Empty File Paths]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.IndexesOfNullOrEmptyPaths" >}} [PropertyEmptyException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyEmptyException.MainDoc" >}} [PropertyNullException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyNullException.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/delete-folder/delete-folders-block.md b/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/delete-folder/delete-folders-block.md index 1fdfb6cf1..88b4cf7a4 100644 --- a/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/delete-folder/delete-folders-block.md +++ b/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/delete-folder/delete-folders-block.md @@ -118,8 +118,8 @@ The exceptions thrown by the block can be found below: | Name | Description | |----------|----------| -| [OperationFailedException][] | Any folder path in [Folder Paths][FolderPaths Property] is `null` or empty (i.e. `""`). For more information, see [Null or Empty Folder Paths][]. | -| | Any folder path in [Folder Paths][FolderPaths Property] is duplicated. For more information, see [Duplicate Folder Paths][]. | +| [OperationFailedException][] | Any folder path in [Folder Paths][FolderPaths Property] is `null` or empty (i.e. `""`). | +| | Any folder path in [Folder Paths][FolderPaths Property] is duplicated. | | | Any folder path in [Folder Paths][FolderPaths Property] points to a file. | | | Any folder path in [Folder Paths][FolderPaths Property] contains leading spaces. | | | Any folder path in [Folder Paths][FolderPaths Property] contains only whitespace, or the NUL character (i.e. `\0`), or contains one or more invalid characters (i.e. `"`, `*`, `?`, `\|`, `<`, `>`, `:`, `\`, `/`) in any folder names. | @@ -160,8 +160,6 @@ If an exception occurs when trying to delete a folder in [Folder Paths][FolderPa [Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} [OperationFailedException]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.MainDoc" >}} -[Duplicate Folder Paths]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.IndexesOfDuplicatePaths" >}} -[Null Or Empty Folder Paths]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.IndexesOfNullOrEmptyPaths" >}} [PropertyEmptyException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyEmptyException.MainDoc" >}} [PropertyNullException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyNullException.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/move-file/move-files-block.md b/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/move-file/move-files-block.md index c223d3da7..c042cda1b 100644 --- a/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/move-file/move-files-block.md +++ b/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/move-file/move-files-block.md @@ -146,8 +146,8 @@ The exceptions thrown by the block can be found below: | | The [Destination Path][DestinationPath Property] contains leading spaces. | | | The [Destination Path][DestinationPath Property] contains only whitespace, or the NUL character (i.e. `\0`), or contains one or more invalid characters (i.e. `"`, `*`, `?`, `\|`, `<`, `>`, `:`, `\`, `/`) in any file or folder names. | | | The [Destination Path][DestinationPath Property] (if it points to a file), or the [Destination Path][DestinationPath Property] (if it points to a folder) plus the file name, exceeds the system-defined maximum length (typically 32,767 characters). | -| [OperationFailedException][] | Any file path in [File Paths][FilePaths Property] is `null` or empty (i.e. `""`). For more information, see [Null or Empty File Paths][]| -| | Any file path in [File Paths][FilePaths Property] is duplicated. For more information, see [Duplicate File Paths][] | +| [OperationFailedException][] | Any file path in [File Paths][FilePaths Property] is `null` or empty (i.e. `""`). | +| | Any file path in [File Paths][FilePaths Property] is duplicated. | | | Any file path in [File Paths][FilePaths Property] does not exist. | | | Any file path in [File Paths][FilePaths Property] points to a folder. | | | Any file path in [File Paths][FilePaths Property] contains leading spaces. | @@ -197,8 +197,6 @@ If an exception occurs when trying to move a file in the [File Paths][FilePaths [InvalidPathException]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.InvalidPathException.MainDoc" >}} [OperationFailedException]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.MainDoc" >}} -[Duplicate File Paths]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.IndexesOfDuplicatePaths" >}} -[Null Or Empty File Paths]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.IndexesOfNullOrEmptyPaths" >}} [PropertyEmptyException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyEmptyException.MainDoc" >}} [PropertyNullException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyNullException.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/move-folder/move-folders-block.md b/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/move-folder/move-folders-block.md index 8ebdd0aee..8c5809944 100644 --- a/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/move-folder/move-folders-block.md +++ b/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/move-folder/move-folders-block.md @@ -406,8 +406,8 @@ The exceptions thrown by the block can be found below: | | The [Destination Path][DestinationPath Property] contains leading spaces. | | | The [Destination Path][DestinationPath Property] contains only whitespace, or the NUL character (i.e. `\0`), or contains one or more invalid characters (i.e. `"`, `*`, `?`, `\|`, `<`, `>`, `:`, `\`, `/`) in any folder names. | | | The [Destination Path][DestinationPath Property] exceeds the system-defined maximum length (typically 32,767 characters). | -| [OperationFailedException][] | Any folder path in [Folder Paths][FolderPaths Property] is `null` or empty (i.e. `""`). For more information, see [Null or Empty Folder Paths][]| -| | Any folder path in [Folder Paths][FolderPaths Property] is duplicated. For more information, see [Duplicate Folder Paths][] | +| [OperationFailedException][] | Any folder path in [Folder Paths][FolderPaths Property] is `null` or empty (i.e. `""`). | +| | Any folder path in [Folder Paths][FolderPaths Property] is duplicated. | | | Any folder path in [Folder Paths][FolderPaths Property] does not exist. | | | Any folder path in [Folder Paths][FolderPaths Property] points to a file. | | | Any folder path in [Folder Paths][FolderPaths Property] contains leading spaces. | @@ -475,8 +475,6 @@ If an exception occurs when trying to move a folder in [Folder Paths][FolderPath [InvalidPathException]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.InvalidPathException.MainDoc" >}} [OperationFailedException]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.MainDoc" >}} -[Duplicate Folder Paths]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.IndexesOfDuplicatePaths" >}} -[Null Or Empty Folder Paths]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.IndexesOfNullOrEmptyPaths" >}} [PropertyEmptyException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyEmptyException.MainDoc" >}} [PropertyNullException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyNullException.MainDoc" >}} diff --git a/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/search-file/search-files-block.md b/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/search-file/search-files-block.md index 599c2e26c..253b5c5b8 100644 --- a/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/search-file/search-files-block.md +++ b/content/en/docs/2024.1/Reference/Blocks/Files-And-Folders/search-file/search-files-block.md @@ -425,8 +425,8 @@ The exceptions thrown by the block can be found below: | [ArgumentException][] | Thrown when [Search Options][SearchOptions Property] is not one of the specified [SearchOptions][] types (e.g. `(SearchOptions)10`). | | | Thrown when [Comparison Type][ComparisonType Property] is not one of the specified [StringComparison][] types (e.g. `(StringComparison)10`). | | [InvalidPropertyValueException][] | Thrown when [Encoding][Encoding Property] is invalid (e.g. `Encoding.GetEncoding(-1)`). See [Value Is Invalid][]. | -| [OperationFailedException][] | Any file path in [File Paths][FilePaths Property] is `null` or empty (i.e. `""`). For more information, see [Null or Empty File Paths][]| -| | Any file path in [File Paths][FilePaths Property] is duplicated. For more information, see [Duplicate File Paths][] | +| [OperationFailedException][] | Any file path in [File Paths][FilePaths Property] is `null` or empty (i.e. `""`). | +| | Any file path in [File Paths][FilePaths Property] is duplicated. | | | Any file path in [File Paths][FilePaths Property] does not exist. | | | Any file path in [File Paths][FilePaths Property] points to a folder. | | | Any file path in [File Paths][FilePaths Property] contains leading spaces. | @@ -500,8 +500,6 @@ If an exception occurs when trying to search a file in the [File Paths][FilePath [Value Is Invalid]: {{< url path="Cortex.Reference.Exceptions.Flows.Blocks.InvalidPropertyValueException.ValueIsInvalid" >}} [OperationFailedException]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.MainDoc" >}} -[Duplicate File Paths]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.IndexesOfDuplicatePaths" >}} -[Null Or Empty File Paths]: {{< url path="Cortex.Reference.Exceptions.FilesAndFolders.OperationFailedException.IndexesOfNullOrEmptyPaths" >}} [PropertyEmptyException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyEmptyException.MainDoc" >}} [PropertyNullException]: {{< url path="Cortex.Reference.Exceptions.Common.Property.PropertyNullException.MainDoc" >}} [RegexMatchTimeoutException]: {{< url path="MSDocs.DotNet.Api.System.Text.RegularExpressions.RegexMatchTimeoutException" >}} diff --git a/content/en/docs/2024.1/Reference/Exceptions/Lists/cannot-modify-read-only-list-exception.md b/content/en/docs/2024.1/Reference/Exceptions/Lists/cannot-modify-read-only-list-exception.md index 28082d26d..58f7c331f 100644 --- a/content/en/docs/2024.1/Reference/Exceptions/Lists/cannot-modify-read-only-list-exception.md +++ b/content/en/docs/2024.1/Reference/Exceptions/Lists/cannot-modify-read-only-list-exception.md @@ -7,32 +7,66 @@ description: "The exception thrown when trying to modify a read-only list." # {{% param title %}}

(Cortex.Exceptions.Lists.CannotModifyReadOnlyListException)

+{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}} + +## Description The exception thrown when trying to modify a read-only list. -> Lists deriving from [IList][]<[T][]> have the option to be read-only. +> Lists implementing [IList][]<[TItem][]> have the option to be read-only (e.g. [IReadOnlyList][]<[TItem][]>). + +## Reasons + +### Attempting to modify a read-only list + +The execution is attempting to perform a non-read operation on a read-only [IList][]<[TItem][]>. + +##### Message Format + +There was an attempt to modify a read-only list. + +##### Message Format The format of the exception message is as follows: ```json -"The value of '' cannot be modified. -This is because the value of '' is read-only. -See the CannotModifyReadOnlyListException help page for more information on how to fix this." +"'' cannot be modified because it's read-only. +Please click the HelpLink for more information on how to fix this." ``` -## How to fix +where: + +* `` is the name of the property containing the read-only list. -If the list was written directly into the block property using an [expression][], use a list type that is not read-only, such as [List][]<[T][]>. +#### How to fix -When using a variable, convert the list to a list that can be written to by using the `.ToList()` expression like follows: +If the list was written directly into the block property using an [expression][], use a list type that is not read-only, such as [List][]<[TItem][]>. + +When using a variable, convert the read-only list to a list that can be written to by using the `.ToList()` expression like follows: ```CSharp ($)List.ToList() ``` -TODO: Confirm if this is all correct - look at cannotmodifyreadonlydictionaryexception for consistency +## Remarks + +### Known Limitations + +None + +## See Also -[T]: {{< url path="Cortex.Reference.Concepts.Fundamentals.DataTypes.Generics.MainDoc" >}} +#### External Documentation + +* [System.Collections.Generic.IList<T>][MS IList] +* [System.Collections.Generic.List<T>][MS List] + +[TItem]: {{< url path="Cortex.Reference.Concepts.Fundamentals.DataTypes.Generics.MainDoc" >}} [expression]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.Expressions" >}} -[List]: {{< url path="MSDocs.DotNet.Api.System.Collections.Generic.List" >}} -[IList]: {{< url path="MSDocs.DotNet.Api.System.Collections.Generic.IList" >}} + +[List]: {{}} +[IList]: {{}} +[IReadOnlyList]: {{}} + +[MS List]: {{< url path="MSDocs.DotNet.Api.System.Collections.Generic.List" >}} +[MS IList]: {{< url path="MSDocs.DotNet.Api.System.Collections.Generic.IList" >}} \ No newline at end of file diff --git a/content/en/docs/2024.1/Reference/Exceptions/Lists/duplicate-value-exception.md b/content/en/docs/2024.1/Reference/Exceptions/Lists/duplicate-value-exception.md index f2c5af02d..e5b81f1aa 100644 --- a/content/en/docs/2024.1/Reference/Exceptions/Lists/duplicate-value-exception.md +++ b/content/en/docs/2024.1/Reference/Exceptions/Lists/duplicate-value-exception.md @@ -1,22 +1,54 @@ --- title: "DuplicateValueException" linkTitle: "DuplicateValueException" -description: "The exception thrown when a list contains duplicate values and shouldn't." +description: "The exception thrown when a list has duplicate values but shouldn't." --- - # {{% param title %}}

(Cortex.Exceptions.Lists.DuplicateValueException)

+{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}} + +## Description + +The exception thrown when a [list][IList] has duplicate values but shouldn't. + +## Reasons -TODO: The exception thrown when... +### Duplicate values in list when not supported + +A [list][IList] provided for an operation requiring unique values contains at least one duplicate value (e.g. providing duplicate indexes for the `Indexes` property of the [Get Items At Indexes][] block). + +#### Message Format The format of the exception message is as follows: ```json -TODO: Format +"The value of '' cannot contain duplicate values. +The values in '' are duplicated. +Please click the HelpLink for more information on how to fix this." ``` -## How to fix +where: + +* `` is the name of the property containing the list that has duplicate values. +* `` is the list of values that are duplicated in the list. + +#### How to fix + +Ensure that duplicate values do not exist within the list being provided. + +## Remarks + +### Known Limitations + +None + +## See Also + +### External Documentation + +None -TODO: How to fix... +[IList]: {{}} +[Get Items At Indexes]: {{}} \ No newline at end of file diff --git a/content/en/docs/2024.1/Reference/Exceptions/files-and-folders/invalid-folder-name-exception.md b/content/en/docs/2024.1/Reference/Exceptions/files-and-folders/invalid-folder-name-exception.md index a0b1b4af3..604cd165a 100644 --- a/content/en/docs/2024.1/Reference/Exceptions/files-and-folders/invalid-folder-name-exception.md +++ b/content/en/docs/2024.1/Reference/Exceptions/files-and-folders/invalid-folder-name-exception.md @@ -7,16 +7,49 @@ description: "The exception thrown when a folder name is invalid." # {{% param title %}}

(Cortex.Exceptions.FilesAndFolders.InvalidFolderNameException)

+{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}} + +## Description The exception thrown when specifying an invalid folder name. +## Reasons + +### Invalid folder name provided + +The folder name provided is invalid. + +#### Message Format + The format of the exception message is as follows: ```json -"TODO. +"The '' given was ''; this is not a valid folder name. Please click the HelpLink for more information on how to fix this." ``` -## How to fix +where: + +* `` is the name of the property containing the folder name which threw this exception. +* `` is the value of the property, i.e. the folder name, which was invalid. + +#### How to fix + +Ensure that the folder name provided is a valid folder name; please see [Naming Conventions][] for more information. + +## Remarks + +### Known Limitations + +None + +## See Also + +### External Documentation + +* [Naming Files, Paths, and Namespaces][NamingFilesPathsAndNamespaces] -TODO: +[FolderConcepts]: {{}} +[WhatIsAPath]: {{}} +[Naming Conventions]: {{}} +[NamingFilesPathsAndNamespaces]: {{}} \ No newline at end of file diff --git a/content/en/docs/2024.1/Reference/Exceptions/files-and-folders/invalid-path-exception.md b/content/en/docs/2024.1/Reference/Exceptions/files-and-folders/invalid-path-exception.md index ebc02f06d..249266e6e 100644 --- a/content/en/docs/2024.1/Reference/Exceptions/files-and-folders/invalid-path-exception.md +++ b/content/en/docs/2024.1/Reference/Exceptions/files-and-folders/invalid-path-exception.md @@ -7,16 +7,72 @@ description: "The exception thrown when a file or folder path is invalid." # {{% param title %}}

(Cortex.Exceptions.FilesAndFolders.InvalidPathException)

+{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}} -The exception thrown when specifying an invalid file or folder path. +## Description + +The exception thrown when specifying an invalid file or folder [path][WhatIsAPath]. + +## Reasons + + +### Path provided is invalid + +The provided [path][WhatIsAPath] has an incorrect syntax, or has illegal characters, or is too long. + +#### Message Format + +The format of the exception message is as follows: + +```json +"The '' given was ''; this is not a valid folder path. Please see the 'InnerException' property for more details. +Please click the HelpLink for more information on how to fix this." +``` + +where: + +* `` is the name of the property containing the path which threw this exception. +* `` is the value of the property, i.e. the path, which was invalid. + +#### How to fix + +Ensure that the [path][WhatIsAPath] provided has no incorrect syntax or illegal characters, and that it is not too long; see [Paths][] for more information. + +### Path provided must represent a folder and that path must not point to an existing file + +The provided [path][WhatIsAPath] needs to be a folder, and must not point to an existing file. + +#### Message Format The format of the exception message is as follows: ```json -"TODO. +"The '' given was ''; this is not a valid folder path. Please click the HelpLink for more information on how to fix this." ``` -## How to fix +where: + +* `` is the name of the property containing the path which threw this exception. +* `` is the value of the property, i.e. the path, which was invalid. + +#### How to fix + +Ensure that the [path][WhatIsAPath] provided is a valid folder path and does not point to an existing file; see [Paths][] for more information. + +## Remarks + +### Known Limitations + +None + +## See Also + +### External Documentation + +* [Naming Files, Paths, and Namespaces][NamingFilesPathsAndNamespaces] -TODO: +[FolderConcepts]: {{}} +[WhatIsAPath]: {{}} +[NamingFilesPathsAndNamespaces]: {{}} +[Paths]: {{}} \ No newline at end of file diff --git a/content/en/docs/2024.1/Reference/Exceptions/files-and-folders/operation-failed-exception.md b/content/en/docs/2024.1/Reference/Exceptions/files-and-folders/operation-failed-exception.md index 269dffdfe..b7d77f671 100644 --- a/content/en/docs/2024.1/Reference/Exceptions/files-and-folders/operation-failed-exception.md +++ b/content/en/docs/2024.1/Reference/Exceptions/files-and-folders/operation-failed-exception.md @@ -7,56 +7,77 @@ description: "The exception thrown when a file or folder operation failed for on # {{% param title %}}

(Cortex.Exceptions.FilesAndFolders.OperationFailedException)

+{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}} + +## Description The exception thrown when a file or folder operation failed for one or more paths. -## Path Exceptions +## Reasons + +### A single exception was thrown + +An exception was thrown, such as [InvalidFolderNameException][] or [InvalidPathException][], while performing an operation on the path provided. -### PathDoesNotExist +#### Message Format -The format of the exception message is as follows: +The format of the message is as follows: ```json -"TODO. +"Failed to the path. Please see the 'PathExceptions' property for details on why the operation failed. Please click the HelpLink for more information on how to fix this." ``` +where: + +* `` is the action taking place when the operation failed (i.e. `copy`, `create`, `delete`, `duplicate`, `get`, `move`, `read`, `rename`, `search`, `write`). + #### How to fix -TODO: +The exception that caused the operation to fail can be seen in the `PathExceptions` property; for how to fix, please refer to the exception's HelpLink. -#### Blocks that can throw this exception +### Multiple exceptions were thrown -TODO: +Multiple exceptions were thrown, such as [InvalidFolderNameException][] or [InvalidPathException][], while performing operations on the paths provided. -### PathTooLong +#### Message Format -The format of the exception message is as follows: +The format of the message is as follows: ```json -"TODO. +"Failed to of paths. Please see the 'PathExceptions' property for details on why each operation failed. Please click the HelpLink for more information on how to fix this." ``` +where: + +* `` is the action taking place when the operation failed (i.e. `copy`, `create`, `delete`, `duplicate`, `get`, `move`, `read`, `rename`, `search`, `write`). +* `` is the number of paths that were attempted to be operated on where the operation failed (e.g. `2`). +* `` is the total number of paths that were attempted to be operated on (e.g. `5`). + #### How to fix -TODO: +The exceptions that caused the operations to fail can be seen in the `PathExceptions` property; for how to fix, please refer to each exception's HelpLink. + +## Remarks + +### Known Limitations + +None + +## See Also -#### Blocks that can throw this exception +### External Documentation -TODO: +None -## Indexes Of Duplicate Paths +[Message]: {{< ref "#message" >}} -/// If any path in the specified filePaths is duplicated and no exception is thrown for that path, the block will only process the first occurrence of the path, skipping any other occurrences. - - /// If any path in the specified filePaths is duplicated and an exception occurs for that path an OperationFailedException will be thrown, and the path added to the "IndexesOfDuplicatePaths" dictionary in OperationFailedException. - -## Indexes Of Null Or Empty Paths +[Blocks]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.MainDoc" >}} +[Block Properties]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.MainDoc" >}} +[Exceptions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.MainDoc" >}} -/// If any path in the specified filePaths is null or empty, an OperationFailedException will be thrown, and the path added to the "IndexesOfNullOrEmptyPaths" list in OperationFailedException. - - -## How to fix +[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}} -TODO: +[InvalidFolderNameException]: {{}} +[InvalidPathException]: {{}} \ No newline at end of file diff --git a/content/en/docs/2024.1/Reference/Exceptions/flows/flow-exception.md b/content/en/docs/2024.1/Reference/Exceptions/flows/flow-exception.md index 814b495f8..406d8d40b 100644 --- a/content/en/docs/2024.1/Reference/Exceptions/flows/flow-exception.md +++ b/content/en/docs/2024.1/Reference/Exceptions/flows/flow-exception.md @@ -1,17 +1,50 @@ --- title: "FlowException" linkTitle: "FlowException" -description: "The exception thrown by the ThrowNewFlowException block." +description: "The exception thrown by the Throw New Flow Exception block." --- # {{% param title %}}

(Cortex.Exceptions.Flows.FlowException)

+{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}} -The exception thrown by the ThrowNewFlowException block. +## Description -TODO: +The exception thrown by the [Throw New Flow Exception][ThrowNewFlowException Block] block. -## How to fix +## Reasons -TODO: +### Thrown by block + +An instance of the [Throw New Flow Exception][ThrowNewFlowException Block] block has been executed in a flow. + +#### Message Format + +The format of the exception message is as follows: + +```json +"" +``` + +where: + +* `` is the user-defined message specified by the `Message` property of the [Throw New Flow Exception][ThrowNewFlowException Block] block. + +#### How to fix + +Ensure that the issue which caused the execution to progress through to the [Throw New Flow Exception][ThrowNewFlowException Block] block is resolved. + +## Remarks + +### Known Limitations + +None + +## See Also + +### External Documentation + +None + +[ThrowNewFlowException Block]: {{}} \ No newline at end of file diff --git a/content/en/docs/2024.1/Reference/Exceptions/text/regex/regex-parsing-failed-exception.md b/content/en/docs/2024.1/Reference/Exceptions/text/regex/regex-parsing-failed-exception.md index e848d6ba2..fed6fcd85 100644 --- a/content/en/docs/2024.1/Reference/Exceptions/text/regex/regex-parsing-failed-exception.md +++ b/content/en/docs/2024.1/Reference/Exceptions/text/regex/regex-parsing-failed-exception.md @@ -1,21 +1,74 @@ --- title: "RegexParsingFailedException" linkTitle: "RegexParsingFailedException" -description: "The exception thrown when a property is provided with an invalid regex value." +description: "The exception thrown when a property is provided with invalid regex syntax." --- # {{% param title %}}

(Cortex.Exceptions.Text.Regex.RegexParsingFailedException)

-The exception thrown when a property is provided with an invalid regex value. +{{% alert type="information" title="Information" %}}Improvements to this page are planned for the future.{{% /alert %}} + +## Description + +The exception thrown when a property is provided with invalid [regex syntax][regex]. + +## Reasons + +### Single regex pattern failed to parse + +A regex pattern in the property value failed to parse successfully due to invalid [regex syntax][regex] (e.g. `"*"`). + +#### Message Format The format of the exception message is as follows: ```json -TODO +"'' contains regex pattern \"\" which could not be parsed successfully. Please see the 'RegexParseExceptions' property for details on why the regex failed. +Please click the HelpLink for more information on how to fix this." ``` -## How to fix +where: + +* `` is the name of the property containing the regex pattern that failed to parse. +* `` is the pattern with the invalid regex syntax. + +#### How to fix + +Provide valid [regex syntax][regex], for the regex pattern seen in the `RegexParseExceptions` property. + +### Multiple regex patterns failed to parse + +Multiple regex patterns in the property value failed to parse successfully due to invalid [regex syntax][regex] (e.g. `"*"`). + +#### Message Format + +The format of the exception message is as follows: + +```json +"'' contains one or more regex patterns which could not be parsed succesfully. Please see the 'RegexParseExceptions' property for details on why each regex failed. +Please click the HelpLink for more information on how to fix this." +``` + +where: + +* `` is the name of the property containing the regex patterns that failed to parse. + +#### How to fix + +Provide valid [regex syntax][regex], for each regex pattern seen in the `RegexParseExceptions` property. + +## Remarks + +### Known Limitations + +None + +## See Also + +### External Documentation + +None -Provide a valid regex value for the property. +[regex]: {{}} \ No newline at end of file diff --git a/data/urls.toml b/data/urls.toml index 9e0346143..c57023ba2 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -1495,6 +1495,8 @@ MainDoc = "/docs/reference/data-types/files-and-folders/contentoptions" [Cortex.Reference.DataTypes.FilesAndFolders.FileInformation] MainDoc = "/docs/reference/data-types/files-and-folders/fileinformation" + [Cortex.Reference.DataTypes.FilesAndFolders.FileSystemInformation] + MainDoc = "/docs/reference/data-types/files-and-folders/filesysteminformation" [Cortex.Reference.DataTypes.FilesAndFolders.FileMatch] MainDoc = "/docs/reference/data-types/files-and-folders/filematch" [Cortex.Reference.DataTypes.FilesAndFolders.FolderInformation] @@ -2458,6 +2460,10 @@ MainDoc = "https://azure.microsoft.com/en-us/services/service-fabric/" Explorer = "https://learn.microsoft.com/en-us/azure/service-fabric/service-fabric-visualizing-your-cluster" ReverseProxy = "https://learn.microsoft.com/en-us/azure/service-fabric/service-fabric-reverseproxy" + [MSDocs.Windows.Apps.Win32.DesktopTechnologies.DataAccessAndStorage.LocalFileSystems.NamingFilesPathsAndNamespaces] + MainDoc = "https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file" + NamingConventions = "https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file#naming-conventions" + Paths = "https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file#paths" [MSDotNet] [MSDotNet.Framework471] MainDoc = "https://dotnet.microsoft.com/en-us/download/dotnet-framework/net471"