diff --git a/xml/Microsoft.Build.Tasks.Windows/GenerateTemporaryTargetAssembly.xml b/xml/Microsoft.Build.Tasks.Windows/GenerateTemporaryTargetAssembly.xml index 6dcb2553f17..cf924a43105 100644 --- a/xml/Microsoft.Build.Tasks.Windows/GenerateTemporaryTargetAssembly.xml +++ b/xml/Microsoft.Build.Tasks.Windows/GenerateTemporaryTargetAssembly.xml @@ -107,8 +107,8 @@ System.String - Gets or sets the MS Build target name which is used to generate assembly from source code files. - The MS Build target name which is used to generate assembly from source code files. + Gets or sets the MSBuild target name that's used to generate assembly from source code files. + The MSBuild target name that's used to generate assembly from source code files. To be added. @@ -144,8 +144,8 @@ System.String - Gets or sets the appropriate item name which can be accepted by managed compiler task. - The appropriate item name which can be accepted by managed compiler task. + Gets or sets the appropriate item name that can be accepted by managed compiler task. + The appropriate item name that can be accepted by managed compiler task. To be added. @@ -414,8 +414,8 @@ System.String - Gets or sets the item name which is used to keep the Reference list in managed compiler task. - The item name which is used to keep the Reference list in managed compiler task. + Gets or sets the item name that's used to keep the Reference list in managed compiler task. + The item name that's used to keep the Reference list in managed compiler task. To be added. diff --git a/xml/Microsoft.Build.Tasks.Windows/MarkupCompilePass1.xml b/xml/Microsoft.Build.Tasks.Windows/MarkupCompilePass1.xml index b0e1a626266..a26055e4878 100644 --- a/xml/Microsoft.Build.Tasks.Windows/MarkupCompilePass1.xml +++ b/xml/Microsoft.Build.Tasks.Windows/MarkupCompilePass1.xml @@ -107,11 +107,11 @@ to run the compilation in second application domain; otherwise, . - @@ -215,7 +215,7 @@ Gets or sets the short name of assembly that will be generated for this project. - The short name of assembly which will be generated for this project. + The short name of assembly that will be generated for this project. To be added. diff --git a/xml/Microsoft.Build.Tasks.Windows/MarkupCompilePass2.xml b/xml/Microsoft.Build.Tasks.Windows/MarkupCompilePass2.xml index 7b990665ad2..7b12ecf29d5 100644 --- a/xml/Microsoft.Build.Tasks.Windows/MarkupCompilePass2.xml +++ b/xml/Microsoft.Build.Tasks.Windows/MarkupCompilePass2.xml @@ -138,7 +138,7 @@ Gets or sets the short name of assembly that will be generated for this project. - The short name of assembly which will be generated for this project. + The short name of assembly that will be generated for this project. To be added. diff --git a/xml/Microsoft.VisualBasic.FileIO/FileSystem.xml b/xml/Microsoft.VisualBasic.FileIO/FileSystem.xml index 3971fee6eb6..e33b1593cf5 100644 --- a/xml/Microsoft.VisualBasic.FileIO/FileSystem.xml +++ b/xml/Microsoft.VisualBasic.FileIO/FileSystem.xml @@ -34,46 +34,46 @@ Provides properties and methods for working with drives, files, and directories. - |[How to: Read Text from Files with a StreamReader](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-read-text-from-files-with-a-streamreader)| -|Write to a text file|[How to: Write Text to Files](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-write-text-to-files)| -|Append to a text file|[How to: Append to Text Files](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-append-to-text-files)| -|Write to a binary file|[How to: Write to Binary Files](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-write-to-binary-files)| -|Write to text files in the **MyDocuments** directory|[How to: Write Text to Files in the My Documents Directory](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-write-text-to-files-in-the-my-documents-directory)| -|Write to a text file with a `StreamWriter`|[How to: Write Text to Files with a StreamWriter](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-write-text-to-files-with-a-streamwriter)| -|Copy files with a specific pattern|[How to: Copy Files with a Specific Pattern to a Directory](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-copy-files-with-a-specific-pattern-to-a-directory)| -|Copy a file to the same directory|[How to: Create a Copy of a File in the Same Directory](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-create-a-copy-of-a-file-in-the-same-directory)| -|Copy a file to a different directory|[How to: Create a Copy of a File in a Different Directory](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-create-a-copy-of-a-file-in-a-different-directory)| -|Create a file|[How to: Create a File](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-create-a-file)| -|Delete a file|[How to: Delete a File](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-delete-a-file)| -|Find files with a specific pattern|[How to: Find Files with a Specific Pattern](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-find-files-with-a-specific-pattern)| -|Move a file|[How to: Move a File](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-move-a-file)| -|Rename a file|[How to: Rename a File](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-rename-a-file)| -|Copy a directory to another directory|[How to: Copy a Directory to Another Directory](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-copy-a-directory-to-another-directory)| -|Create a directory|[How to: Create a Directory](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-create-a-directory)| -|Find subdirectories with a specific pattern|[How to: Find Subdirectories with a Specific Pattern](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-find-subdirectories-with-a-specific-pattern)| -|Get the collection of files in a directory|[How to: Get the Collection of Files in a Directory](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-get-the-collection-of-files-in-a-directory)| -|Read from the **MyDocuments** directory|[How to: Retrieve the Contents of the My Documents Directory](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-retrieve-the-contents-of-the-my-documents-directory)| -|Parse a file path|[How to: Parse File Paths](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-parse-file-paths)| - - - -## Examples - This example checks to determine whether the folder `C:\backup\logs` exists and checks its properties. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnMyFileSystem/VB/Class1.vb" id="Snippet23"::: - + |[How to: Read Text from Files with a StreamReader](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-read-text-from-files-with-a-streamreader)| +|Write to a text file|[How to: Write Text to Files](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-write-text-to-files)| +|Append to a text file|[How to: Append to Text Files](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-append-to-text-files)| +|Write to a binary file|[How to: Write to Binary Files](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-write-to-binary-files)| +|Write to text files in the **MyDocuments** directory|[How to: Write Text to Files in the My Documents Directory](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-write-text-to-files-in-the-my-documents-directory)| +|Write to a text file with a `StreamWriter`|[How to: Write Text to Files with a StreamWriter](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-write-text-to-files-with-a-streamwriter)| +|Copy files with a specific pattern|[How to: Copy Files with a Specific Pattern to a Directory](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-copy-files-with-a-specific-pattern-to-a-directory)| +|Copy a file to the same directory|[How to: Create a Copy of a File in the Same Directory](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-create-a-copy-of-a-file-in-the-same-directory)| +|Copy a file to a different directory|[How to: Create a Copy of a File in a Different Directory](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-create-a-copy-of-a-file-in-a-different-directory)| +|Create a file|[How to: Create a File](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-create-a-file)| +|Delete a file|[How to: Delete a File](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-delete-a-file)| +|Find files with a specific pattern|[How to: Find Files with a Specific Pattern](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-find-files-with-a-specific-pattern)| +|Move a file|[How to: Move a File](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-move-a-file)| +|Rename a file|[How to: Rename a File](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-rename-a-file)| +|Copy a directory to another directory|[How to: Copy a Directory to Another Directory](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-copy-a-directory-to-another-directory)| +|Create a directory|[How to: Create a Directory](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-create-a-directory)| +|Find subdirectories with a specific pattern|[How to: Find Subdirectories with a Specific Pattern](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-find-subdirectories-with-a-specific-pattern)| +|Get the collection of files in a directory|[How to: Get the Collection of Files in a Directory](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-get-the-collection-of-files-in-a-directory)| +|Read from the **MyDocuments** directory|[How to: Retrieve the Contents of the My Documents Directory](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-retrieve-the-contents-of-the-my-documents-directory)| +|Parse a file path|[How to: Parse File Paths](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-parse-file-paths)| + + + +## Examples + This example checks to determine whether the folder `C:\backup\logs` exists and checks its properties. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnMyFileSystem/VB/Class1.vb" id="Snippet23"::: + ]]> @@ -114,11 +114,11 @@ Initializes a new instance of the class. - @@ -171,30 +171,30 @@ Combines two paths and returns a properly formatted path. The combination of the specified paths. - @@ -254,28 +254,28 @@ The location to which the directory contents should be copied. Copies the contents of a directory to another directory. - in which the file or directory path is the key and the specific exception message is contained in the corresponding value. Use `For…Each` to enumerate through the entries. - - The following table lists an example of a task involving the `My.Computer.FileSystem.CopyDirectory` method. - -|To|See| -|-|-| -|Copy a directory|[How to: Copy a Directory to Another Directory in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-copy-a-directory-to-another-directory)| - - - -## Examples - The following example copies the contents of directory `TestDirectory1` into `TestDirectory2`. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnMyFileSystem/VB/Class1.vb" id="Snippet94"::: - - Replace `C:\TestDirectory1` and `C:\TestDirectory2` with the path and name of the directory you wish to copy and the location to which you wish to copy it. - + in which the file or directory path is the key and the specific exception message is contained in the corresponding value. Use `For…Each` to enumerate through the entries. + + The following table lists an example of a task involving the `My.Computer.FileSystem.CopyDirectory` method. + +|To|See| +|-|-| +|Copy a directory|[How to: Copy a Directory to Another Directory in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-copy-a-directory-to-another-directory)| + + + +## Examples + The following example copies the contents of directory `TestDirectory1` into `TestDirectory2`. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnMyFileSystem/VB/Class1.vb" id="Snippet94"::: + + Replace `C:\TestDirectory1` and `C:\TestDirectory2` with the path and name of the directory you wish to copy and the location to which you wish to copy it. + ]]> The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\). @@ -330,28 +330,28 @@ Whether to visually track the operation's progress. Default is . Copies the contents of a directory to another directory. - in which the file or directory path is the key and the specific exception message is contained in the corresponding value. Use `For…Each` to enumerate through the entries. - - The following table lists an example of a task involving the `My.Computer.FileSystem.CopyDirectory` method. - -|To|See| -|-|-| -|Copy a directory|[How to: Copy a Directory to Another Directory in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-copy-a-directory-to-another-directory)| - - - -## Examples - The following example copies the contents of directory `TestDirectory1` into `TestDirectory2`, showing progress dialog and any error dialog. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnMyFileSystem/VB/Class1.vb" id="Snippet92"::: - - Replace `C:\TestDirectory1` and `C:\TestDirectory2` with the path and name of the directory you wish to copy and the location to which you wish to copy it. - + in which the file or directory path is the key and the specific exception message is contained in the corresponding value. Use `For…Each` to enumerate through the entries. + + The following table lists an example of a task involving the `My.Computer.FileSystem.CopyDirectory` method. + +|To|See| +|-|-| +|Copy a directory|[How to: Copy a Directory to Another Directory in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-copy-a-directory-to-another-directory)| + + + +## Examples + The following example copies the contents of directory `TestDirectory1` into `TestDirectory2`, showing progress dialog and any error dialog. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnMyFileSystem/VB/Class1.vb" id="Snippet92"::: + + Replace `C:\TestDirectory1` and `C:\TestDirectory2` with the path and name of the directory you wish to copy and the location to which you wish to copy it. + ]]> The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\). @@ -415,28 +415,28 @@ to overwrite existing files; otherwise . Default is . Copies the contents of a directory to another directory. - in which the file or directory path is the key and the specific exception message is contained in the corresponding value. Use `For…Each` to enumerate through the entries. - - The following table lists an example of a task involving the `My.Computer.FileSystem.CopyDirectory` method. - -|To|See| -|-|-| -|Copy a directory|[How to: Copy a Directory to Another Directory in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-copy-a-directory-to-another-directory)| - - - -## Examples - The following example copies the contents of directory `TestDirectory1` into `TestDirectory2`, overwriting existing files. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnMyFileSystem/VB/Class1.vb" id="Snippet49"::: - - Replace `C:\TestDirectory1` and `C:\TestDirectory2` with the path and name of the directory you wish to copy and the location to which you wish to copy it. - + in which the file or directory path is the key and the specific exception message is contained in the corresponding value. Use `For…Each` to enumerate through the entries. + + The following table lists an example of a task involving the `My.Computer.FileSystem.CopyDirectory` method. + +|To|See| +|-|-| +|Copy a directory|[How to: Copy a Directory to Another Directory in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-copy-a-directory-to-another-directory)| + + + +## Examples + The following example copies the contents of directory `TestDirectory1` into `TestDirectory2`, overwriting existing files. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnMyFileSystem/VB/Class1.vb" id="Snippet49"::: + + Replace `C:\TestDirectory1` and `C:\TestDirectory2` with the path and name of the directory you wish to copy and the location to which you wish to copy it. + ]]> The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\). @@ -493,28 +493,28 @@ Specifies what should be done if the user clicks **Cancel** during the operation. Default is . Copies the contents of a directory to another directory. - in which the file or directory path is the key and the specific exception message is contained in the corresponding value. Use `For…Each` to enumerate through the entries. - - The following table lists an example of a task involving the `My.Computer.FileSystem.CopyDirectory` method. - -|To|See| -|-|-| -|Copy a directory|[How to: Copy a Directory to Another Directory in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-copy-a-directory-to-another-directory)| - - - -## Examples - The following example copies the contents of directory `TestDirectory1` into `TestDirectory2`, showing progress dialog and any error dialog, and does nothing if the user clicks **Cancel** during the operation. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnMyFileSystem/VB/Class1.vb" id="Snippet93"::: - - Replace `C:\TestDirectory1` and `C:\TestDirectory2` with the path and name of the directory you wish to copy and the location to which you wish to copy it. - + in which the file or directory path is the key and the specific exception message is contained in the corresponding value. Use `For…Each` to enumerate through the entries. + + The following table lists an example of a task involving the `My.Computer.FileSystem.CopyDirectory` method. + +|To|See| +|-|-| +|Copy a directory|[How to: Copy a Directory to Another Directory in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-copy-a-directory-to-another-directory)| + + + +## Examples + The following example copies the contents of directory `TestDirectory1` into `TestDirectory2`, showing progress dialog and any error dialog, and does nothing if the user clicks **Cancel** during the operation. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnMyFileSystem/VB/Class1.vb" id="Snippet93"::: + + Replace `C:\TestDirectory1` and `C:\TestDirectory2` with the path and name of the directory you wish to copy and the location to which you wish to copy it. + ]]> The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\). @@ -584,33 +584,33 @@ The location to which the file should be copied. Copies a file to a new location. - @@ -665,33 +665,33 @@ Whether to visually track the operation's progress. Default is . Copies a file to a new location. - @@ -753,33 +753,33 @@ if existing files should be overwritten; otherwise . Default is . Copies a file to a new location. - @@ -836,33 +836,33 @@ Specifies what should be done if the user clicks **Cancel** during the operation. Default is . Copies a file to a new location. - @@ -915,24 +915,24 @@ Name and location of the directory. Creates a directory. - The directory name is malformed. For example, it contains illegal characters or is only white space. @@ -976,22 +976,22 @@ Gets or sets the current directory. The current directory for file I/O operations. - The path is not valid. @@ -1050,25 +1050,25 @@ Specifies what should be done when a directory that is to be deleted contains files or directories. Default is . Deletes a directory. - The path is a zero-length string, is malformed, contains only white space, or contains invalid characters (including wildcard characters). The path is a device path (starts with \\\\.\\). @@ -1122,30 +1122,30 @@ Specifies whether or not the deleted file should be sent to the **Recycle Bin**. Default is . Deletes a directory. - The path is a zero-length string, is malformed, contains only white space, or contains invalid characters (including wildcard characters). The path is a device path (starts with \\\\.\\). @@ -1202,30 +1202,30 @@ Specifies whether to throw an exception if the user clicks **Cancel**. Deletes a directory. - The path is a zero-length string, is malformed, contains only white space, or contains invalid characters (including wildcard characters). The path is a device path (starts with \\\\.\\). @@ -1292,30 +1292,30 @@ Name and path of the file to be deleted. Deletes a file. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; it has a trailing slash where a file must be specified; or it is a device path (starts with \\\\.\\). @@ -1368,32 +1368,32 @@ Whether or not the deleted file should be sent to the **Recycle Bin**. Default is . Deletes a file. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; it has a trailing slash where a file must be specified; or it is a device path (starts with \\\\.\\). @@ -1450,32 +1450,32 @@ Specifies whether or not an exception is thrown when the user cancels the operation. Default is . Deletes a file. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; it has a trailing slash where a file must be specified; or it is a device path (starts with \\\\.\\). @@ -1530,13 +1530,13 @@ if the directory exists; otherwise . This method also returns if the parameter represents the name and path of a file rather than a directory. - @@ -1572,18 +1572,18 @@ Returns a read-only collection of all available drive names. A read-only collection of all available drives as objects. - @@ -1626,18 +1626,18 @@ Returns if the specified file exists. Returns if the file exists; otherwise this method returns . This method also returns if the parameter represents the path of a directory rather than a file. - The name of the file ends with a backslash (\\). @@ -1701,26 +1701,26 @@ Returns a read-only collection of strings representing the names of files containing the specified text. Read-only collection of the names of files containing the specified text. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\.\). @@ -1788,26 +1788,26 @@ Returns a read-only collection of strings representing the names of files containing the specified text. Read-only collection of the names of files containing the specified text. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\.\). @@ -1874,24 +1874,24 @@ Returns a collection of strings representing the path names of subdirectories within a directory. Read-only collection of the path names of subdirectories within the specified directory. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\). @@ -1960,28 +1960,28 @@ Returns a collection of strings representing the path names of subdirectories within a directory. Read-only collection of the path names of subdirectories within the specified directory. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\). @@ -2034,18 +2034,18 @@ object for the specified path. - object is accessed. - - - -## Examples - This example gets a object for the directory `C:\Documents and Settings` and displays the directory's creation time, last access time, and last write time. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet7"::: - + object is accessed. + + + +## Examples + This example gets a object for the directory `C:\Documents and Settings` and displays the directory's creation time, last access time, and last write time. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet7"::: + ]]> The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\). @@ -2094,20 +2094,20 @@ object for the specified drive. - class models a drive and provides methods and properties to query for drive information. Use to determine what drives are available, and what type of drives they are. You can also query the property to determine the capacity and available free space on the drive. - - - -## Examples - This example obtains a object for the C drive and uses it to display information about the drive. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet11"::: - - For information on the different drive types, see . - + class models a drive and provides methods and properties to query for drive information. Use to determine what drives are available, and what type of drives they are. You can also query the property to determine the capacity and available free space on the drive. + + + +## Examples + This example obtains a object for the C drive and uses it to display information about the drive. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet11"::: + + For information on the different drive types, see . + ]]> The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\). @@ -2156,24 +2156,24 @@ object for the specified file. - object for the file `MyLogFile.log` and uses it to report the file's full name, last access time, and length. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet1"::: - + object for the file `MyLogFile.log` and uses it to report the file's full name, last access time, and length. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet1"::: + ]]> The path name is malformed. For example, it contains invalid characters or is only white space. The file name has a trailing slash mark. @@ -2237,33 +2237,33 @@ Returns a read-only collection of strings representing the names of files within a directory. Read-only collection of file names from the specified directory. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\). @@ -2332,33 +2332,33 @@ Returns a read-only collection of strings representing the names of files within a directory. Read-only collection of file names from the specified directory. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\). @@ -2411,28 +2411,28 @@ Parses the file name out of the path provided. The file name from the specified path. - @@ -2473,18 +2473,18 @@ Returns the parent path of the provided path. The parent path of the provided path. - Path does not have a parent path because it is a root path. @@ -2528,18 +2528,18 @@ containing the full path of the temporary file. - @@ -2596,22 +2596,22 @@ Path of the directory to which the source directory is being moved. Moves a directory from one location to another. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\). @@ -2667,22 +2667,22 @@ Specifies whether to visually track the operation's progress. Default is . Moves a directory from one location to another. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\). @@ -2746,22 +2746,22 @@ if existing directories should be overwritten; otherwise . Default is . Moves a directory from one location to another. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\). @@ -2819,22 +2819,22 @@ Specifies whether or not an exception is thrown when the user cancels the operation. Default is . Moves a directory from one location to another. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\). @@ -2908,30 +2908,30 @@ Path of the directory into which the file should be moved. Moves a file to a new location. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\); it ends with a trailing slash. @@ -2983,30 +2983,30 @@ Specifies whether to visually track the operation's progress. Default is . Moves a file to a new location. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\); it ends with a trailing slash. @@ -3066,30 +3066,30 @@ to overwrite existing files; otherwise . Default is . Moves a file to a new location. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\); it ends with a trailing slash. @@ -3143,30 +3143,30 @@ Specifies whether or not an exception is thrown when the user cancels the operation. Default is . Moves a file to a new location. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\); it ends with a trailing slash. @@ -3225,28 +3225,28 @@ The file to be opened with the . - The method allows you to create a object, which provides a way to easily and efficiently parse structured text files, such as logs. The object can be used to read both delimited and fixed-width files. + The method allows you to create a object, which provides a way to easily and efficiently parse structured text files, such as logs. The object can be used to read both delimited and fixed-width files. to read the specified file. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\); it ends with a trailing slash. @@ -3307,24 +3307,24 @@ to read the specified file. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\); it ends with a trailing slash. @@ -3385,24 +3385,24 @@ to read the specified file. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\); it ends with a trailing slash. @@ -3463,24 +3463,24 @@ object to read from the file. - . - - The following table lists an example of a task involving the `My.Computer.FileSystem.OpenTextFileReader` method. - -|To|See| -|-|-| -|Open a file with a |[How to: Read Text from Files with a StreamReader (Visual Basic)](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-read-text-from-files-with-a-streamreader)| - - - -## Examples - This example opens the file `Testfile.txt`, reads a line from it, and displays the line in a `MessageBox`. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet2"::: - + . + + The following table lists an example of a task involving the `My.Computer.FileSystem.OpenTextFileReader` method. + +|To|See| +|-|-| +|Open a file with a |[How to: Read Text from Files with a StreamReader (Visual Basic)](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-read-text-from-files-with-a-streamreader)| + + + +## Examples + This example opens the file `Testfile.txt`, reads a line from it, and displays the line in a `MessageBox`. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet2"::: + ]]> The file name ends with a backslash (\\). @@ -3529,24 +3529,24 @@ object to read from the file. - . - - The following table lists an example of a task involving the `My.Computer.FileSystem.OpenTextFileReader` method. - -|To|See| -|-|-| -|Open a file with a |[How to: Read Text from Files with a StreamReader (Visual Basic)](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-read-text-from-files-with-a-streamreader)| - - - -## Examples - This example opens the file `Testfile.txt`, reads a line from it, and displays the line in a `MessageBox`. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet2"::: - + . + + The following table lists an example of a task involving the `My.Computer.FileSystem.OpenTextFileReader` method. + +|To|See| +|-|-| +|Open a file with a |[How to: Read Text from Files with a StreamReader (Visual Basic)](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-read-text-from-files-with-a-streamreader)| + + + +## Examples + This example opens the file `Testfile.txt`, reads a line from it, and displays the line in a `MessageBox`. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet2"::: + ]]> The file name ends with a backslash (\\). @@ -3605,29 +3605,29 @@ object to write to the specified file. - object for that stream. You can write to the steam as many times as necessary and then close it when you are finished. - + object for that stream. You can write to the steam as many times as necessary and then close it when you are finished. + > [!NOTE] -> You must call the method on the object to make sure that all data is correctly written to the underlying stream. - - If you are writing only a few strings to a file, it might be simpler to use the method. - - The following table lists an example of a task involving the `My.Computer.FileSystem.OpenTextFileWriter` method. - -|To|See| -|-|-| -|Write text to a file with a `StreamWriter`|[How to: Write Text to Files with a StreamWriter in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-write-text-to-files-with-a-streamwriter)| - - - -## Examples - This example opens a with the `My.Computer.FileSystem.OpenTextFileWriter` method and uses it to write a string to a text file with the `WriteLine` method of the `StreamWriter` class. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet14"::: - +> You must call the method on the object to make sure that all data is correctly written to the underlying stream. + + If you are writing only a few strings to a file, it might be simpler to use the method. + + The following table lists an example of a task involving the `My.Computer.FileSystem.OpenTextFileWriter` method. + +|To|See| +|-|-| +|Write text to a file with a `StreamWriter`|[How to: Write Text to Files with a StreamWriter in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-write-text-to-files-with-a-streamwriter)| + + + +## Examples + This example opens a with the `My.Computer.FileSystem.OpenTextFileWriter` method and uses it to write a string to a text file with the `WriteLine` method of the `StreamWriter` class. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet14"::: + ]]> @@ -3679,29 +3679,29 @@ object to write to the specified file. - object for that stream. You can write to the steam as many times as necessary and then close it when you are finished. - + object for that stream. You can write to the steam as many times as necessary and then close it when you are finished. + > [!NOTE] -> You must call the method on the object to make sure that all data is correctly written to the underlying stream. - - If you are writing only a few strings to a file, it might be simpler to use the method. - - The following table lists an example of a task involving the `My.Computer.FileSystem.OpenTextFileWriter` method. - -|To|See| -|-|-| -|Write text to a file with a `StreamWriter`|[How to: Write Text to Files with a StreamWriter in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-write-text-to-files-with-a-streamwriter)| - - - -## Examples - This example opens a with the `My.Computer.FileSystem.OpenTextFileWriter` method with `Unicode` encoding and uses it to write a string to a text file with the `WriteLine` method of the `StreamWriter` class. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet23"::: - +> You must call the method on the object to make sure that all data is correctly written to the underlying stream. + + If you are writing only a few strings to a file, it might be simpler to use the method. + + The following table lists an example of a task involving the `My.Computer.FileSystem.OpenTextFileWriter` method. + +|To|See| +|-|-| +|Write text to a file with a `StreamWriter`|[How to: Write Text to Files with a StreamWriter in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-write-text-to-files-with-a-streamwriter)| + + + +## Examples + This example opens a with the `My.Computer.FileSystem.OpenTextFileWriter` method with `Unicode` encoding and uses it to write a string to a text file with the `WriteLine` method of the `StreamWriter` class. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet23"::: + ]]> @@ -3748,26 +3748,26 @@ array containing the contents of the file. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\); it ends with a trailing slash. @@ -3827,32 +3827,32 @@ containing the contents of the file. - method. - - Do not make decisions about the contents of the file based on the name of the file. For example, the file Form1.vb may not be a Visual Basic source file. Verify all inputs before using the data in your application. - - The following table lists an example of a task involving the `My.Computer.FileSystem.ReadAllText` method. - -|To|See| -|-|-| -|Read from a text file|[How to: Read From Text Files in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-read-from-text-files)| - - - -## Examples - This example reads the contents of `Test.txt` into a string and then displays it in a message box. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet8"::: - - This example reads the contents of the ASCII file `Test.txt` into a string and then displays it in a message box. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet9"::: - + method. + + Do not make decisions about the contents of the file based on the name of the file. For example, the file Form1.vb may not be a Visual Basic source file. Verify all inputs before using the data in your application. + + The following table lists an example of a task involving the `My.Computer.FileSystem.ReadAllText` method. + +|To|See| +|-|-| +|Read from a text file|[How to: Read From Text Files in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-read-from-text-files)| + + + +## Examples + This example reads the contents of `Test.txt` into a string and then displays it in a message box. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet8"::: + + This example reads the contents of the ASCII file `Test.txt` into a string and then displays it in a message box. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet9"::: + ]]> The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\); it ends with a trailing slash. @@ -3908,32 +3908,32 @@ containing the contents of the file. - The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\); it ends with a trailing slash. @@ -3986,27 +3986,27 @@ New name for directory. Renames a directory. - contains path information. - is . - - -or- - + is . + + -or- + is or an empty string. The directory does not exist. There is an existing file or directory with the name specified in . @@ -4054,35 +4054,35 @@ New name of file. Renames a file. - method to move and rename the file. - - The following table lists an example of a task involving the `My.Computer.FileSystem.RenameFile` method. - -|To|See| -|-|-| -|Rename a file|[How to: Rename a File in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-rename-a-file)| - - - -## Examples - This example renames the file `Test.txt` to `SecondTest.txt`. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnMyFileSystem/VB/Class1.vb" id="Snippet1"::: - - Change "`C:\Test.txt`" to the path and file name of the file that you want to rename. - + method to move and rename the file. + + The following table lists an example of a task involving the `My.Computer.FileSystem.RenameFile` method. + +|To|See| +|-|-| +|Rename a file|[How to: Rename a File in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-rename-a-file)| + + + +## Examples + This example renames the file `Test.txt` to `SecondTest.txt`. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnMyFileSystem/VB/Class1.vb" id="Snippet1"::: + + Change "`C:\Test.txt`" to the path and file name of the file that you want to rename. + ]]> contains path information or ends with a backslash (\\). - is . - - -or- - + is . + + -or- + is or an empty string. The directory does not exist. There is an existing file or directory with the name specified in . @@ -4132,27 +4132,27 @@ to append to the file contents; to overwrite the file contents. Default is . Writes data to a binary file. - exception will be thrown. If the path is valid but the file does not exist, the file is created. - + exception will be thrown. If the path is valid but the file does not exist, the file is created. + > [!NOTE] -> The `WriteAllBytes` method opens a file, writes to it, and then closes it. Code that uses the `WriteAllBytes` method is simpler than code that uses a object. However, if you are adding data to a file using a loop, a object can provide better performance because you only have to open and close the file once. - - The following table lists an example of a task involving the `My.Computer.FileSystem.WriteAllBytes` method. - -|To|See| -|-|-| -|Write to a binary file|[How to: Write to Binary Files in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-write-to-binary-files)| - - - -## Examples - This example appends the data array `CustomerData` to the file `CollectedData`. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnMyFileSystem/VB/Class1.vb" id="Snippet50"::: - +> The `WriteAllBytes` method opens a file, writes to it, and then closes it. Code that uses the `WriteAllBytes` method is simpler than code that uses a object. However, if you are adding data to a file using a loop, a object can provide better performance because you only have to open and close the file once. + + The following table lists an example of a task involving the `My.Computer.FileSystem.WriteAllBytes` method. + +|To|See| +|-|-| +|Write to a binary file|[How to: Write to Binary Files in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-write-to-binary-files)| + + + +## Examples + This example appends the data array `CustomerData` to the file `CollectedData`. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnMyFileSystem/VB/Class1.vb" id="Snippet50"::: + ]]> The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\); it ends with a trailing slash. @@ -4215,36 +4215,36 @@ to append to the contents of the file; to overwrite the contents of the file. Writes text to a file. - method. - - If the specified file does not exist, it is created. - - If the specified encoding does not match the existing encoding of the file, the specified coding is ignored. - + method. + + If the specified file does not exist, it is created. + + If the specified encoding does not match the existing encoding of the file, the specified coding is ignored. + > [!NOTE] -> The `WriteAllText` method opens a file, writes to it, and then closes it. Code that uses the `WriteAllText` method is simpler than code that uses a object. However, if you are adding strings to a file by using a loop, a object can provide better performance because you only have to open and close the file one time. For more information, see the method. - - The following table lists examples of tasks involving the `My.Computer.FileSystem.WriteAllText` method. - -|To|See| -|-|-| -|Write text to a file|[How to: Write Text to Files in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-write-text-to-files)| -|Append text to a file|[How to: Append to Text Files in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-append-to-text-files)| - - - -## Examples - This example writes the line `"This is new text to be added."` to the file `Test.txt`, overwriting any existing text in the file. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet21"::: - - This example writes the names of the files in the `Documents and Settings` folder to `FileList.txt`, inserting a carriage return between each for better readability. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet22"::: - +> The `WriteAllText` method opens a file, writes to it, and then closes it. Code that uses the `WriteAllText` method is simpler than code that uses a object. However, if you are adding strings to a file by using a loop, a object can provide better performance because you only have to open and close the file one time. For more information, see the method. + + The following table lists examples of tasks involving the `My.Computer.FileSystem.WriteAllText` method. + +|To|See| +|-|-| +|Write text to a file|[How to: Write Text to Files in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-write-text-to-files)| +|Append text to a file|[How to: Append to Text Files in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-append-to-text-files)| + + + +## Examples + This example writes the line `"This is new text to be added."` to the file `Test.txt`, overwriting any existing text in the file. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet21"::: + + This example writes the names of the files in the `Documents and Settings` folder to `FileList.txt`, inserting a carriage return between each for better readability. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet22"::: + ]]> The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\); it ends with a trailing slash. @@ -4302,34 +4302,34 @@ What encoding to use when writing to file. Writes text to a file. - [!NOTE] -> The `WriteAllText` method opens a file, writes to it, and then closes it. Code that uses the `WriteAllText` method is simpler than code that uses a object. However, if you are adding strings to a file by using a loop, a object can provide better performance because you only have to open and close the file one time. For more information, see the method. - - The following table lists examples of tasks involving the `My.Computer.FileSystem.WriteAllText` method. - -|To|See| -|-|-| -|Write text to a file|[How to: Write Text to Files in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-write-text-to-files)| -|Append text to a file|[How to: Append to Text Files in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-append-to-text-files)| - - - -## Examples - This example writes the line `"This is new text to be added."` to the file `Test.txt`, overwriting any existing text in the file. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet21"::: - - This example writes the names of the files in the `Documents and Settings` folder to `FileList.txt`, inserting a carriage return between each for better readability. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet22"::: - +> The `WriteAllText` method opens a file, writes to it, and then closes it. Code that uses the `WriteAllText` method is simpler than code that uses a object. However, if you are adding strings to a file by using a loop, a object can provide better performance because you only have to open and close the file one time. For more information, see the method. + + The following table lists examples of tasks involving the `My.Computer.FileSystem.WriteAllText` method. + +|To|See| +|-|-| +|Write text to a file|[How to: Write Text to Files in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-write-text-to-files)| +|Append text to a file|[How to: Append to Text Files in Visual Basic](/dotnet/visual-basic/developing-apps/programming/drives-directories-files/how-to-append-to-text-files)| + + + +## Examples + This example writes the line `"This is new text to be added."` to the file `Test.txt`, overwriting any existing text in the file. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet21"::: + + This example writes the names of the files in the `Documents and Settings` folder to `FileList.txt`, inserting a carriage return between each for better readability. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbRefFile/VB/Class1.vb" id="Snippet22"::: + ]]> The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\\\.\\); it ends with a trailing slash. diff --git a/xml/Microsoft.VisualBasic.MyServices/RegistryProxy.xml b/xml/Microsoft.VisualBasic.MyServices/RegistryProxy.xml index 7d766329c08..8b2ae1e7c62 100644 --- a/xml/Microsoft.VisualBasic.MyServices/RegistryProxy.xml +++ b/xml/Microsoft.VisualBasic.MyServices/RegistryProxy.xml @@ -36,26 +36,26 @@ Provides properties and methods for manipulating the registry. - enumeration. Any code running with full trust (under the default security policy, this is any code installed on the user's local hard drive) has the necessary permissions to access the registry. For more information, see the class. - - The following table lists examples of tasks involving the `My.Computer.Registry` object. - -|To|See| -|--------|---------| -|Create a registry key and set its value|[How to: Create a Registry Key and Set Its Value](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-create-a-registry-key-and-set-its-value)| -|Delete a registry key|[How to: Delete a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-delete-a-registry-key)| -|Read data from the registry|[How to: Read a Value from a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-read-a-value-from-a-registry-key)| - - - -## Examples - This example reads the value `Name` from `HKEY_CURRENT_USER\Software\MyApp` and displays it in a message box. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyRegistry/VB/Class1.vb" id="Snippet8"::: - + enumeration. Any code running with full trust (under the default security policy, this is any code installed on the user's local hard drive) has the necessary permissions to access the registry. For more information, see the class. + + The following table lists examples of tasks involving the `My.Computer.Registry` object. + +|To|See| +|--------|---------| +|Create a registry key and set its value|[How to: Create a Registry Key and Set Its Value](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-create-a-registry-key-and-set-its-value)| +|Delete a registry key|[How to: Delete a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-delete-a-registry-key)| +|Read data from the registry|[How to: Read a Value from a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-read-a-value-from-a-registry-key)| + + + +## Examples + This example reads the value `Name` from `HKEY_CURRENT_USER\Software\MyApp` and displays it in a message box. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyRegistry/VB/Class1.vb" id="Snippet8"::: + ]]> @@ -95,45 +95,45 @@ Microsoft.Win32.RegistryKey - Returns a type which provides access to . + Returns a type that provides access to . - class, which is in the namespace, controls access to registry variables. Registry variables should not be stored in memory locations where code without can access them. Similarly, when granting permissions, grant only those privileges necessary to get the job done. - - Registry permission access values are defined by the enumeration. The following table details its members. - -|Value|Description| -|-----------|-----------------| -|AllAccess|Create, read, and write access to registry variables.| -|Create|Create access to registry variables.| -|NoAccess|No access to registry variables.| -|Read|Read access to registry variables.| -|Write|Write access to registry variables.| - - The following table lists examples of tasks involving the `My.Computer.Registry` object. - -|To|See| -|--------|---------| -|Create a registry key and set its value|[How to: Create a Registry Key and Set Its Value](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-create-a-registry-key-and-set-its-value)| -|Delete a registry key|[How to: Delete a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-delete-a-registry-key)| -|Read a value from a registry key|[How to: Read a Value from a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-read-a-value-from-a-registry-key)| - - - -## Examples - This example gets the names of the subkeys for the `ClassesRoot` registry key and adds them to `ListBox1`. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyRegistry/VB/Class1.vb" id="Snippet10"::: - - This example requires that you have a `ListBox` named `ListBox1` in your project. - + class, which is in the namespace, controls access to registry variables. Registry variables should not be stored in memory locations where code without can access them. Similarly, when granting permissions, grant only those privileges necessary to get the job done. + + Registry permission access values are defined by the enumeration. The following table details its members. + +|Value|Description| +|-----------|-----------------| +|AllAccess|Create, read, and write access to registry variables.| +|Create|Create access to registry variables.| +|NoAccess|No access to registry variables.| +|Read|Read access to registry variables.| +|Write|Write access to registry variables.| + + The following table lists examples of tasks involving the `My.Computer.Registry` object. + +|To|See| +|--------|---------| +|Create a registry key and set its value|[How to: Create a Registry Key and Set Its Value](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-create-a-registry-key-and-set-its-value)| +|Delete a registry key|[How to: Delete a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-delete-a-registry-key)| +|Read a value from a registry key|[How to: Read a Value from a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-read-a-value-from-a-registry-key)| + + + +## Examples + This example gets the names of the subkeys for the `ClassesRoot` registry key and adds them to `ListBox1`. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyRegistry/VB/Class1.vb" id="Snippet10"::: + + This example requires that you have a `ListBox` named `ListBox1` in your project. + ]]> @@ -175,43 +175,43 @@ Microsoft.Win32.RegistryKey - Returns a type which provides access to . + Returns a type that provides access to . - class, which is in the namespace, controls access to registry variables. Registry variables should not be stored in memory locations where code without can access them. Similarly, when granting permissions, grant only those privileges necessary to get the job done. - - Registry permission access values are defined by the enumeration. The following table details its members. - -|Value|Description| -|-----------|-----------------| -|AllAccess|Create, read, and write access to registry variables.| -|Create|Create access to registry variables.| -|NoAccess|No access to registry variables.| -|Read|Read access to registry variables.| -|Write|Write access to registry variables.| - - The following table lists examples of tasks involving the `My.Computer.Registry` object. - -|To|See| -|--------|---------| -|Create a registry key and set its value|[How to: Create a Registry Key and Set Its Value](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-create-a-registry-key-and-set-its-value)| -|Delete a registry key|[How to: Delete a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-delete-a-registry-key)| -|Read a value from a registry key|[How to: Read a Value from a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-read-a-value-from-a-registry-key)| - - - -## Examples - This example creates the subkey `MyDeviceSettings`. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyRegistry/VB/Class1.vb" id="Snippet5"::: - + class, which is in the namespace, controls access to registry variables. Registry variables should not be stored in memory locations where code without can access them. Similarly, when granting permissions, grant only those privileges necessary to get the job done. + + Registry permission access values are defined by the enumeration. The following table details its members. + +|Value|Description| +|-----------|-----------------| +|AllAccess|Create, read, and write access to registry variables.| +|Create|Create access to registry variables.| +|NoAccess|No access to registry variables.| +|Read|Read access to registry variables.| +|Write|Write access to registry variables.| + + The following table lists examples of tasks involving the `My.Computer.Registry` object. + +|To|See| +|--------|---------| +|Create a registry key and set its value|[How to: Create a Registry Key and Set Its Value](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-create-a-registry-key-and-set-its-value)| +|Delete a registry key|[How to: Delete a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-delete-a-registry-key)| +|Read a value from a registry key|[How to: Read a Value from a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-read-a-value-from-a-registry-key)| + + + +## Examples + This example creates the subkey `MyDeviceSettings`. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyRegistry/VB/Class1.vb" id="Snippet5"::: + ]]> @@ -253,43 +253,43 @@ Microsoft.Win32.RegistryKey - Returns a type which provides access to . + Returns a type that provides access to . - class, which is in the namespace, controls access to registry variables. Registry variables should not be stored in memory locations where code without can access them. Similarly, when granting permissions, grant the fewest privileges necessary to get the job done. - - Registry permission access values are defined by the enumeration. The following table details its members. - -|Value|Description| -|-----------|-----------------| -|AllAccess|Create, read, and write access to registry variables.| -|Create|Create access to registry variables.| -|NoAccess|No access to registry variables.| -|Read|Read access to registry variables.| -|Write|Write access to registry variables.| - - The following table lists examples of tasks involving the `My.Computer.Registry` object. - -|To|See| -|--------|---------| -|Create a registry key and set its value|[How to: Create a Registry Key and Set Its Value](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-create-a-registry-key-and-set-its-value)| -|Delete a registry key|[How to: Delete a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-delete-a-registry-key)| -|Read a value from a registry key|[How to: Read a Value from a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-read-a-value-from-a-registry-key)| - - - -## Examples - This example deletes the subkey `Software\MyCompany\Preferences\UserData`. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyRegistry/VB/Class1.vb" id="Snippet2"::: - + class, which is in the namespace, controls access to registry variables. Registry variables should not be stored in memory locations where code without can access them. Similarly, when granting permissions, grant the fewest privileges necessary to get the job done. + + Registry permission access values are defined by the enumeration. The following table details its members. + +|Value|Description| +|-----------|-----------------| +|AllAccess|Create, read, and write access to registry variables.| +|Create|Create access to registry variables.| +|NoAccess|No access to registry variables.| +|Read|Read access to registry variables.| +|Write|Write access to registry variables.| + + The following table lists examples of tasks involving the `My.Computer.Registry` object. + +|To|See| +|--------|---------| +|Create a registry key and set its value|[How to: Create a Registry Key and Set Its Value](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-create-a-registry-key-and-set-its-value)| +|Delete a registry key|[How to: Delete a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-delete-a-registry-key)| +|Read a value from a registry key|[How to: Read a Value from a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-read-a-value-from-a-registry-key)| + + + +## Examples + This example deletes the subkey `Software\MyCompany\Preferences\UserData`. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyRegistry/VB/Class1.vb" id="Snippet2"::: + ]]> @@ -374,26 +374,26 @@ Gets a value from a registry key. Gets a value from a registry key. - The user does not have the permissions required to read from the registry key. @@ -442,38 +442,38 @@ - class, which is in the namespace, controls access to registry variables. Registry variables should not be stored in memory locations where code without can access them. Similarly, when granting permissions, grant the fewest privileges necessary to get the job done. - - Registry permission access values are defined by the enumeration. The following table details its members. - -|Value|Description| -|-----------|-----------------| -|AllAccess|Create, read, and write access to registry variables.| -|Create|Create access to registry variables.| -|NoAccess|No access to registry variables.| -|Read|Read access to registry variables.| -|Write|Write access to registry variables.| - - The following table lists examples of tasks involving the `My.Computer.Registry` object. - -|To|See| -|--------|---------| -|Create a registry key and set its value|[How to: Create a Registry Key and Set Its Value](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-create-a-registry-key-and-set-its-value)| -|Delete a registry key|[How to: Delete a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-delete-a-registry-key)| -|Read a value from a registry key|[How to: Read a Value from a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-read-a-value-from-a-registry-key)| - - - -## Examples - This example opens the subkey `Software\MyCompany\Preferences` and sets the value `FontColor` to `"red"`. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyRegistry/VB/Class1.vb" id="Snippet3"::: - + class, which is in the namespace, controls access to registry variables. Registry variables should not be stored in memory locations where code without can access them. Similarly, when granting permissions, grant the fewest privileges necessary to get the job done. + + Registry permission access values are defined by the enumeration. The following table details its members. + +|Value|Description| +|-----------|-----------------| +|AllAccess|Create, read, and write access to registry variables.| +|Create|Create access to registry variables.| +|NoAccess|No access to registry variables.| +|Read|Read access to registry variables.| +|Write|Write access to registry variables.| + + The following table lists examples of tasks involving the `My.Computer.Registry` object. + +|To|See| +|--------|---------| +|Create a registry key and set its value|[How to: Create a Registry Key and Set Its Value](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-create-a-registry-key-and-set-its-value)| +|Delete a registry key|[How to: Delete a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-delete-a-registry-key)| +|Read a value from a registry key|[How to: Read a Value from a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-read-a-value-from-a-registry-key)| + + + +## Examples + This example opens the subkey `Software\MyCompany\Preferences` and sets the value `FontColor` to `"red"`. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyRegistry/VB/Class1.vb" id="Snippet3"::: + ]]> @@ -520,40 +520,40 @@ - . - - The class, which is in the namespace, controls access to registry variables. Registry variables should not be stored in memory locations where code without can access them. Similarly, when granting permissions, grant the fewest privileges necessary to get the job done. - - Registry permission access values are defined by the enumeration. The following table details its members. - -|Value|Description| -|-----------|-----------------| -|AllAccess|Create, read, and write access to registry variables.| -|Create|Create access to registry variables.| -|NoAccess|No access to registry variables.| -|Read|Read access to registry variables.| -|Write|Write access to registry variables.| - - The following table lists examples of tasks involving the `My.Computer.Registry` object. - -|To|See| -|--------|---------| -|Create a registry key and set its value|[How to: Create a Registry Key and Set Its Value](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-create-a-registry-key-and-set-its-value)| -|Delete a registry key|[How to: Delete a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-delete-a-registry-key)| -|Read a value from a registry key|[How to: Read a Value from a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-read-a-value-from-a-registry-key)| - - - -## Examples - This example gets the value `ThisSoftware` from the `MyCompany` subkey. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyRegistry/VB/Class1.vb" id="Snippet7"::: - + + This key cannot normally be written to; attempting to create a subkey on it will throw an . + + The class, which is in the namespace, controls access to registry variables. Registry variables should not be stored in memory locations where code without can access them. Similarly, when granting permissions, grant the fewest privileges necessary to get the job done. + + Registry permission access values are defined by the enumeration. The following table details its members. + +|Value|Description| +|-----------|-----------------| +|AllAccess|Create, read, and write access to registry variables.| +|Create|Create access to registry variables.| +|NoAccess|No access to registry variables.| +|Read|Read access to registry variables.| +|Write|Write access to registry variables.| + + The following table lists examples of tasks involving the `My.Computer.Registry` object. + +|To|See| +|--------|---------| +|Create a registry key and set its value|[How to: Create a Registry Key and Set Its Value](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-create-a-registry-key-and-set-its-value)| +|Delete a registry key|[How to: Delete a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-delete-a-registry-key)| +|Read a value from a registry key|[How to: Read a Value from a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-read-a-value-from-a-registry-key)| + + + +## Examples + This example gets the value `ThisSoftware` from the `MyCompany` subkey. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyRegistry/VB/Class1.vb" id="Snippet7"::: + ]]> @@ -611,33 +611,33 @@ . Value to be written. Required. Writes a value to a registry key. - is . - does not begin with a valid registry root. - - -or- - + does not begin with a valid registry root. + + -or- + is longer than the maximum length allowed (255 characters). The is read-only and thus cannot be written to; for example, it is a root-level node, or it has not been opened with write access. The user does not have the permissions required to create or modify registry keys. @@ -690,37 +690,37 @@ . Required. Writes a value to a registry key. - is . - does not begin with a valid registry root. - - -or- - - is longer than the maximum length allowed (255 characters). - - -or- - + does not begin with a valid registry root. + + -or- + + is longer than the maximum length allowed (255 characters). + + -or- + The type of does not match the registry data type specified by , therefore the data cannot be converted properly. The is read-only, and thus cannot be written to; for example, it is a root-level node, or it has not been opened with write access. The user does not have the permissions required to create or modify registry keys. @@ -768,38 +768,38 @@ - class, which is in the namespace, controls access to registry variables. Registry variables should not be stored in memory locations where code without can access them. Similarly, when granting permissions, grant the fewest privileges necessary to get the job done. - - Registry permission access values are defined by the enumeration. The following table details its members. - -|Value|Access to Registry Variables| -|-----------|----------------------------------| -|AllAccess|Create, read, and write| -|Create|Create| -|NoAccess|No access.| -|Read|Read| -|Write|Write| - - The following table lists examples of tasks involving the `My.Computer.Registry` object. - -|**To**|**See**| -|------------|-------------| -|Create a registry key and set its value|[How to: Create a Registry Key and Set Its Value](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-create-a-registry-key-and-set-its-value)| -|Delete a registry key|[How to: Delete a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-delete-a-registry-key)| -|Read a value from a registry key|[How to: Read a Value from a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-read-a-value-from-a-registry-key)| - - - -## Examples - This example counts and displays the number of values in the registry key. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyRegistry/VB/Class1.vb" id="Snippet4"::: - + class, which is in the namespace, controls access to registry variables. Registry variables should not be stored in memory locations where code without can access them. Similarly, when granting permissions, grant the fewest privileges necessary to get the job done. + + Registry permission access values are defined by the enumeration. The following table details its members. + +|Value|Access to Registry Variables| +|-----------|----------------------------------| +|AllAccess|Create, read, and write| +|Create|Create| +|NoAccess|No access.| +|Read|Read| +|Write|Write| + + The following table lists examples of tasks involving the `My.Computer.Registry` object. + +|**To**|**See**| +|------------|-------------| +|Create a registry key and set its value|[How to: Create a Registry Key and Set Its Value](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-create-a-registry-key-and-set-its-value)| +|Delete a registry key|[How to: Delete a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-delete-a-registry-key)| +|Read a value from a registry key|[How to: Read a Value from a Registry Key](/dotnet/visual-basic/developing-apps/programming/computer-resources/how-to-read-a-value-from-a-registry-key)| + + + +## Examples + This example counts and displays the number of values in the registry key. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyRegistry/VB/Class1.vb" id="Snippet4"::: + ]]> diff --git a/xml/System.Activities.Hosting/WorkflowInstance.xml b/xml/System.Activities.Hosting/WorkflowInstance.xml index 46fef8c8235..850e3376db3 100644 --- a/xml/System.Activities.Hosting/WorkflowInstance.xml +++ b/xml/System.Activities.Hosting/WorkflowInstance.xml @@ -18,27 +18,27 @@ is a lightweight, per-instance runtime for executing a workflow program. It can be constructed to create a new workflow instance or from existing instance state. The APIs that exposes are the minimal set of runtime controls from which higher level operations can be implemented. This API set represents the entire breadth of functionality of the runtime. is an abstract class and relies on a host's implementation of its abstract methods in order to provide host functionality such as synchronization, persistence, tracking, and extensions. - is single threaded and assumes that the host synchronizes all access to it. An attempt to call multiple APIs simultaneously will result in an being thrown. - - Internally, a has two states: Running and Paused. The only way to cause the runtime to transition from paused to running is to call . All actions (except Pause) can only be taken while the runtime is Paused. The runtime will become spontaneously Paused in the following situations: - -- An error fatal to the runtime has occurred. The host will be signaled through (which does not signal a transition to Paused) and then notified through . - -- An exception in the workflow was uncaught and escaped the root. The host will be notified through the method. - -- The scheduler has run out of work items and is now . The host will be notified through the method. Note that the scheduler could have run out of work items because the instance is idle or because the instance is complete. The value of the property can be used to differentiate between the two. - - The host can request a change from Running to Paused by calling the or methods of the instance returned by the property. This request should not be considered to have a specific response meaning that the host should not attempt to correlate an OnNotify* or with a specific call to pause. In response to a pause request, the runtime may transition to Paused and call while the scheduler still has pending work items. The value of the property can be used to determine whether the scheduler has no more work or was interrupted by a request to pause. - - The method of the instance returned by the property is the only method which can be called while the is in the Running state. All other methods will throw an if called.Given the rules for how transitions from one state to another, the public notion of Running and Paused can be defined as follows: - -- Running - The state between a call to and the next WorkflowInstance.OnNotify*. - -- Paused - The state between the last WorkflowInstance.OnNotify* and the next call to . - + is single threaded and assumes that the host synchronizes all access to it. An attempt to call multiple APIs simultaneously will result in an being thrown. + + Internally, a has two states: Running and Paused. The only way to cause the runtime to transition from paused to running is to call . All actions (except Pause) can only be taken while the runtime is Paused. The runtime will become spontaneously Paused in the following situations: + +- An error fatal to the runtime has occurred. The host will be signaled through (which does not signal a transition to Paused) and then notified through . + +- An exception in the workflow was uncaught and escaped the root. The host will be notified through the method. + +- The scheduler has run out of work items and is now . The host will be notified through the method. Note that the scheduler could have run out of work items because the instance is idle or because the instance is complete. The value of the property can be used to differentiate between the two. + + The host can request a change from Running to Paused by calling the or methods of the instance returned by the property. This request should not be considered to have a specific response meaning that the host should not attempt to correlate an OnNotify* or with a specific call to pause. In response to a pause request, the runtime may transition to Paused and call while the scheduler still has pending work items. The value of the property can be used to determine whether the scheduler has no more work or was interrupted by a request to pause. + + The method of the instance returned by the property is the only method that can be called while the is in the Running state. All other methods will throw an if called.Given the rules for how transitions from one state to another, the public notion of Running and Paused can be defined as follows: + +- Running - The state between a call to and the next WorkflowInstance.OnNotify*. + +- Paused - The state between the last WorkflowInstance.OnNotify* and the next call to . + ]]> @@ -348,11 +348,11 @@ Gets or sets the root environment for the workflow instance's arguments and variables. The root environment for the workflow instance's arguments and variables. - returns `true`, an is thrown. - + returns `true`, an is thrown. + ]]> @@ -799,11 +799,11 @@ The reason for aborting the workflow instance. Called by the workflow runtime to notify the host that an abort operation has been requested for the workflow instance. - is called, most APIs except will throw an . It is expected that after is called a host will trend toward a state in which it can satisfy the abort. - + is called, most APIs except will throw an . It is expected that after is called a host will trend toward a state in which it can satisfy the abort. + ]]> @@ -830,11 +830,11 @@ The extension manager to register. Called by the host to register the specified extension manager, validate that all required extensions are present, and to initialize the collection of extensions to be used. - use the runtime type of the object as the type key. Extensions providers added through use the decared type T of the Func\ as the type key. Extension providers contributed by activities through the various *ActivityMetadata.AddDefaultExtensionProvider methods are dropped if a host extension exists for the declared type or if there is a broader type provided through AddDefaultExtensionProvider (ex. if Func\ is provided and Func\ is provided, only Func\ will be kept). If an extension does not exist in the collection that is required by an activity (expressed by calling *ActivityMetadata.RequireExtension) a is thrown. - + use the runtime type of the object as the type key. Extensions providers added through use the decared type T of the Func\ as the type key. Extension providers contributed by activities through the various *ActivityMetadata.AddDefaultExtensionProvider methods are dropped if a host extension exists for the declared type or if there is a broader type provided through AddDefaultExtensionProvider (ex. if Func\ is provided and Func\ is provided, only Func\ will be kept). If an extension does not exist in the collection that is required by an activity (expressed by calling *ActivityMetadata.RequireExtension) a is thrown. + ]]> @@ -886,11 +886,11 @@ Gets or sets the used for scheduling the workflow instance. The synchronization context used for scheduling the workflow instance. - returns `true`, an is thrown. - + returns `true`, an is thrown. + ]]> @@ -914,11 +914,11 @@ Throws an if the workflow instance has been initialized, as determined by . - returns `true`, then an is thrown. - + returns `true`, then an is thrown. + ]]> diff --git a/xml/System.Activities.Presentation.PropertyEditing/DialogPropertyValueEditor.xml b/xml/System.Activities.Presentation.PropertyEditing/DialogPropertyValueEditor.xml index edc199ba0cc..76f4e9e23d7 100644 --- a/xml/System.Activities.Presentation.PropertyEditing/DialogPropertyValueEditor.xml +++ b/xml/System.Activities.Presentation.PropertyEditing/DialogPropertyValueEditor.xml @@ -16,24 +16,24 @@ Container for all dialog-editing logic for objects. - class to show an inline editor that can have an associated dialog box editor. - - The class can hold either a for a dialog box editor or custom logic that is called when the dialog box is invoked. - - Use the in your to invoke your custom class. - - You can provide a which is shown in a host dialog box, or you can override the method, which enables the reuse of existing or system dialog boxes. - - The following list shows the rules for determining whether the or method is used. - - If the property is not a null reference (Nothing in Visual Basic), that is hosted in a host-specific dialog box, which provides host styling. The is not called. - - If the property is a null reference (Nothing in Visual Basic), the virtual method is called and you can override this method to show any dialog box. - - + class to show an inline editor that can have an associated dialog box editor. + + The class can hold either a for a dialog box editor or custom logic that is called when the dialog box is invoked. + + Use the in your to invoke your custom class. + + You can provide a that's shown in a host dialog box, or you can override the method, which enables the reuse of existing or system dialog boxes. + + The following list shows the rules for determining whether the or method is used. + + If the property is not a null reference (Nothing in Visual Basic), that is hosted in a host-specific dialog box, which provides host styling. The is not called. + + If the property is a null reference (Nothing in Visual Basic), the virtual method is called and you can override this method to show any dialog box. + + ]]> @@ -128,11 +128,11 @@ Gets or sets the that is hosted by a host-specific dialog and has its set to a . The object that is hosted by a host-specific dialog. - method is called instead. - + method is called instead. + ]]> @@ -161,11 +161,11 @@ The that can be used as a source for execution of . Called when the is null and a dialog has been invoked by the user. - that is part of the host's visual tree and that, therefore, can be used to execute property editing commands in such a way that they are handled correctly. Overriding this method enables you to implement any custom dialog logic, such as invoking existing system dialogs. - + that is part of the host's visual tree and that, therefore, can be used to execute property editing commands in such a way that they are handled correctly. Overriding this method enables you to implement any custom dialog logic, such as invoking existing system dialogs. + ]]> diff --git a/xml/System.Activities.Presentation/ActivityDesigner.xml b/xml/System.Activities.Presentation/ActivityDesigner.xml index 58eab577cb0..39e46c8d5ac 100644 --- a/xml/System.Activities.Presentation/ActivityDesigner.xml +++ b/xml/System.Activities.Presentation/ActivityDesigner.xml @@ -16,108 +16,108 @@ Provides a base class for all activity designer components. - and properties of the activity). - - The inherits from and primarily adds the default styling, as well as the ability to customize the icon via the property. It should be used whenever you are creating a designer for a type which derives from . When associated with an type, the property will point to the ModelItem hierarchy describing the instance of that type being edited. - - - -## Examples - In the sample code below, a `First2of3` activity is defined first, then the code for the First2of3 designer is shown, and finally it is shown how to use the Designer attribute to associate the activity with the designer is provided. - -``` - -//The First2of3 activity -using System.Activities; -using System.Collections.Generic; -using System.Linq; - -namespace Microsoft.Activities.Documentation.ActivityTypes -{ - - public sealed class First2of3 : NativeActivity - { - public Activity Activity1 { get; set; } - public Activity Activity2 { get; set; } - public Activity Activity3 { get; set; } - - Variable> ExecutingActivities { get; set; } - - public First2of3() - { - ExecutingActivities = new Variable>(); - } - - // If your activity returns a value, derive from CodeActivity - // and return the value from the Execute method. - protected override void Execute(NativeActivityContext context) - { - // Obtain the runtime value of the Text input argument - var l = new List(); - ExecutingActivities.Set(context, l); - l.Add(context.ScheduleActivity(Activity1, onComplete)); - l.Add(context.ScheduleActivity(Activity2, onComplete)); - l.Add(context.ScheduleActivity(Activity3, onComplete)); - } - - protected override void CacheMetadata(NativeActivityMetadata metadata) - { - metadata.AddImplementationVariable(ExecutingActivities); - metadata.AddChild(Activity1); - metadata.AddChild(Activity2); - metadata.AddChild(Activity3); - } - - private void onComplete(NativeActivityContext context, ActivityInstance completedInstance) - { - var l = ExecutingActivities.Get(context); - l.Remove(completedInstance); - if (l.Count == 1) - { - context.CancelChild(l.Single()); - } - } - } -} - -// Code for the First2of3 Designer: - - - - - - - - - - - - - - - - - - - -//Code for associating the activity with the designer using the Designer attribute. -[Designer(typeof(First2of3Designer))] -public sealed class First2of3 : NativeActivity - -``` - + and properties of the activity). + + The inherits from and primarily adds the default styling, as well as the ability to customize the icon via the property. It should be used whenever you are creating a designer for a type that derives from . When associated with an type, the property will point to the ModelItem hierarchy describing the instance of that type being edited. + + + +## Examples + In the sample code below, a `First2of3` activity is defined first, then the code for the First2of3 designer is shown, and finally it is shown how to use the Designer attribute to associate the activity with the designer is provided. + +``` + +//The First2of3 activity +using System.Activities; +using System.Collections.Generic; +using System.Linq; + +namespace Microsoft.Activities.Documentation.ActivityTypes +{ + + public sealed class First2of3 : NativeActivity + { + public Activity Activity1 { get; set; } + public Activity Activity2 { get; set; } + public Activity Activity3 { get; set; } + + Variable> ExecutingActivities { get; set; } + + public First2of3() + { + ExecutingActivities = new Variable>(); + } + + // If your activity returns a value, derive from CodeActivity + // and return the value from the Execute method. + protected override void Execute(NativeActivityContext context) + { + // Obtain the runtime value of the Text input argument + var l = new List(); + ExecutingActivities.Set(context, l); + l.Add(context.ScheduleActivity(Activity1, onComplete)); + l.Add(context.ScheduleActivity(Activity2, onComplete)); + l.Add(context.ScheduleActivity(Activity3, onComplete)); + } + + protected override void CacheMetadata(NativeActivityMetadata metadata) + { + metadata.AddImplementationVariable(ExecutingActivities); + metadata.AddChild(Activity1); + metadata.AddChild(Activity2); + metadata.AddChild(Activity3); + } + + private void onComplete(NativeActivityContext context, ActivityInstance completedInstance) + { + var l = ExecutingActivities.Get(context); + l.Remove(completedInstance); + if (l.Count == 1) + { + context.CancelChild(l.Single()); + } + } + } +} + +// Code for the First2of3 Designer: + + + + + + + + + + + + + + + + + + + +//Code for associating the activity with the designer using the Designer attribute. +[Designer(typeof(First2of3Designer))] +public sealed class First2of3 : NativeActivity + +``` + ]]> diff --git a/xml/System.Activities.Presentation/ContextItem.xml b/xml/System.Activities.Presentation/ContextItem.xml index e57564fbefa..69a84b159fe 100644 --- a/xml/System.Activities.Presentation/ContextItem.xml +++ b/xml/System.Activities.Presentation/ContextItem.xml @@ -16,11 +16,11 @@ Represents a base class from which all context items must derive. This class is abstract. - , which is part of the employed by a when representing the workflow model visually. The is returned by the property which contains the data that is shared between a host and the designer. This data provides the mechanism needed to hook into subscription and change notification. - + , which is part of the employed by a when representing the workflow model visually. The is returned by the property which contains the data that is shared between a host and the designer. This data provides the mechanism needed to hook into subscription and change notification. + ]]> @@ -67,11 +67,11 @@ When implemented in a derived class, gets the type of item derived from the editing context class. The item . - class. - + class. + ]]> @@ -100,11 +100,11 @@ The previously active . Represents a method that is called on the context item before it is stored in the context item manager. The previous item in the context item manager is passed as a parameter. - diff --git a/xml/System.Activities.Presentation/ObjectReferenceService.xml b/xml/System.Activities.Presentation/ObjectReferenceService.xml index ff34b4dcf0d..a06c980bb90 100644 --- a/xml/System.Activities.Presentation/ObjectReferenceService.xml +++ b/xml/System.Activities.Presentation/ObjectReferenceService.xml @@ -67,7 +67,7 @@ - The object which we need to acquire a reference for. + The object to acquire a reference for. Acquires a reference of an object by its actual reference. A reference of an object. To be added. diff --git a/xml/System.Activities.Statements/State.xml b/xml/System.Activities.Statements/State.xml index 1451a85d9c3..8bb02bce43c 100644 --- a/xml/System.Activities.Statements/State.xml +++ b/xml/System.Activities.Statements/State.xml @@ -14,7 +14,7 @@ - Models the state which a state machine can be in. + Models the state that a state machine can be in. To be added. diff --git a/xml/System.Activities/WorkflowInvoker.xml b/xml/System.Activities/WorkflowInvoker.xml index 1c10aabdf56..fe42f81ac6a 100644 --- a/xml/System.Activities/WorkflowInvoker.xml +++ b/xml/System.Activities/WorkflowInvoker.xml @@ -16,22 +16,22 @@ Provides a means for invoking a workflow as if it were a method call. - contains both instance and static methods for invoking workflows synchronously, and instance methods for invoking workflows asynchronously. - - does not allow instance control such as persisting, unloading, or resuming bookmarks. If instance control is desired, use instead. - - To execute workflows synchronously with no instance control, call the method. To execute a workflow asynchronously with no instance control, use the and method pairs, or the method. - - - -## Examples - The following example synchronously invokes a workflow consisting of a single activity using . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet1"::: - + contains both instance and static methods for invoking workflows synchronously, and instance methods for invoking workflows asynchronously. + + does not allow instance control such as persisting, unloading, or resuming bookmarks. If instance control is desired, use instead. + + To execute workflows synchronously with no instance control, call the method. To execute a workflow asynchronously with no instance control, use the and method pairs, or the method. + + + +## Examples + The following example synchronously invokes a workflow consisting of a single activity using . + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet1"::: + ]]> @@ -55,18 +55,18 @@ The workflow definition of the workflow to be invoked by this instance of the class. Initializes a new instance of the class. - contains both instance and static methods for invoking workflows synchronously, and instance methods for invoking workflows asynchronously. - - - -## Examples - The following example invokes a workflow consisting of a single activity. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet2"::: - + contains both instance and static methods for invoking workflows synchronously, and instance methods for invoking workflows asynchronously. + + + +## Examples + The following example invokes a workflow consisting of a single activity. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet2"::: + ]]> @@ -79,11 +79,11 @@ Invokes a workflow asynchronously using the asynchronous design pattern. - @@ -113,22 +113,22 @@ Invokes a workflow asynchronously using the specified and user-provided state. A reference to the asynchronous invoke operation. - from the `callback` method. If is called before the workflow completes, it blocks until the workflow completes. To configure a time-out interval in which the workflow must complete, use one of the overloads that take a . - - This method invokes a workflow asynchronously using the asynchronous design pattern. For more information, see [Asynchronous Programming Overview](/dotnet/standard/asynchronous-programming-patterns/asynchronous-programming-model-apm). - - - -## Examples - The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. These are retrieved by calling . When the call to returns, each output argument is returned in the outputs dictionary, keyed by argument name. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet32"::: - + from the `callback` method. If is called before the workflow completes, it blocks until the workflow completes. To configure a time-out interval in which the workflow must complete, use one of the overloads that take a . + + This method invokes a workflow asynchronously using the asynchronous design pattern. For more information, see [Asynchronous Programming Overview](/dotnet/standard/asynchronous-programming-patterns/asynchronous-programming-model-apm). + + + +## Examples + The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. These are retrieved by calling . When the call to returns, each output argument is returned in the outputs dictionary, keyed by argument name. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet32"::: + ]]> @@ -160,22 +160,22 @@ Invokes a workflow asynchronously using the specified of input parameters, , and user-provided state. A reference to the asynchronous invoke operation. - from the `callback` method. If is called before the workflow completes, it blocks until the workflow completes. To configure a time-out interval in which the workflow must complete, use one of the overloads that take a . - - This method invokes a workflow asynchronously using the asynchronous design pattern. For more information, see [Asynchronous Programming Overview](/dotnet/standard/asynchronous-programming-patterns/asynchronous-programming-model-apm). - - - -## Examples - The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. These are retrieved by calling . When the call to returns, each output argument is returned in the outputs dictionary, keyed by argument name. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet32"::: - + from the `callback` method. If is called before the workflow completes, it blocks until the workflow completes. To configure a time-out interval in which the workflow must complete, use one of the overloads that take a . + + This method invokes a workflow asynchronously using the asynchronous design pattern. For more information, see [Asynchronous Programming Overview](/dotnet/standard/asynchronous-programming-patterns/asynchronous-programming-model-apm). + + + +## Examples + The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. These are retrieved by calling . When the call to returns, each output argument is returned in the outputs dictionary, keyed by argument name. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet32"::: + ]]> @@ -207,25 +207,25 @@ Invokes a workflow asynchronously using the specified time-out interval, , and user-provided state. A reference to the asynchronous invoke operation. - from the `callback` method. If is called before the workflow completes, it blocks until the workflow completes. If the workflow does not complete within the specified time-out interval the workflow is aborted and a is thrown when the method is called. - + from the `callback` method. If is called before the workflow completes, it blocks until the workflow completes. If the workflow does not complete within the specified time-out interval the workflow is aborted and a is thrown when the method is called. + > [!NOTE] -> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. - - This method invokes a workflow asynchronously using the asynchronous design pattern. For more information, see [Asynchronous Programming Overview](/dotnet/standard/asynchronous-programming-patterns/asynchronous-programming-model-apm). - - - -## Examples - The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. These are retrieved by calling . When the call to returns, each output argument is returned in the outputs dictionary, keyed by argument name. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet32"::: - +> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. + + This method invokes a workflow asynchronously using the asynchronous design pattern. For more information, see [Asynchronous Programming Overview](/dotnet/standard/asynchronous-programming-patterns/asynchronous-programming-model-apm). + + + +## Examples + The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. These are retrieved by calling . When the call to returns, each output argument is returned in the outputs dictionary, keyed by argument name. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet32"::: + ]]> @@ -259,25 +259,25 @@ Invokes a workflow asynchronously using the specified of input parameters, time-out interval, , and user-provided state. A reference to the asynchronous invoke operation. - from the `callback` method. If is called before the workflow completes, it blocks until the workflow completes. If the workflow does not complete within the specified time-out interval the workflow is aborted and a is thrown when is called. - + from the `callback` method. If is called before the workflow completes, it blocks until the workflow completes. If the workflow does not complete within the specified time-out interval the workflow is aborted and a is thrown when is called. + > [!NOTE] -> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. - - This method invokes a workflow asynchronously using the asynchronous design pattern. For more information, see [Asynchronous Programming Overview](/dotnet/standard/asynchronous-programming-patterns/asynchronous-programming-model-apm). - - - -## Examples - The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. These are retrieved by calling . When the call to returns, each output argument is returned in the outputs dictionary, keyed by argument name. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet32"::: - +> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. + + This method invokes a workflow asynchronously using the asynchronous design pattern. For more information, see [Asynchronous Programming Overview](/dotnet/standard/asynchronous-programming-patterns/asynchronous-programming-model-apm). + + + +## Examples + The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. These are retrieved by calling . When the call to returns, each output argument is returned in the outputs dictionary, keyed by argument name. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet32"::: + ]]> @@ -304,22 +304,22 @@ The token for the workflow to cancel. Attempts to cancel the workflow that was invoked with the specified . - overloads that takes a `userState` parameter can be canceled. - - If the cancellation succeeds, the property of the passed to the handler is set to `true`; otherwise, it is set to `false`. - - - -## Examples - The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. Once the workflow is invoked, the host attempts to cancel the workflow. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet34"::: - + overloads that takes a `userState` parameter can be canceled. + + If the cancellation succeeds, the property of the passed to the handler is set to `true`; otherwise, it is set to `false`. + + + +## Examples + The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. Once the workflow is invoked, the host attempts to cancel the workflow. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet34"::: + ]]> @@ -347,22 +347,22 @@ Returns the results of a workflow that was invoked using one of the overloads. A dictionary of the root activity's and values keyed by argument name that represent the outputs of the workflow. - from the `callback` method specified by . If is called before the workflow completes, it blocks until the workflow completes. - - This method returns the result of a workflow invoked asynchronously using the asynchronous design pattern. For more information, see [Asynchronous Programming Overview](/dotnet/standard/asynchronous-programming-patterns/asynchronous-programming-model-apm). - - - -## Examples - The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. These are retrieved by calling . When the call to returns, each output argument is returned in the outputs dictionary, keyed by argument name. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet32"::: - + from the `callback` method specified by . If is called before the workflow completes, it blocks until the workflow completes. + + This method returns the result of a workflow invoked asynchronously using the asynchronous design pattern. For more information, see [Asynchronous Programming Overview](/dotnet/standard/asynchronous-programming-patterns/asynchronous-programming-model-apm). + + + +## Examples + The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. These are retrieved by calling . When the call to returns, each output argument is returned in the outputs dictionary, keyed by argument name. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet32"::: + ]]> @@ -386,18 +386,18 @@ Gets the of extensions that are available to workflows invoked by a instance. The of extensions that are available to workflows invoked by a instance. - instance so they will be available to workflows invoked by it. - - - -## Examples - The following example registers a custom with the collection of a instance. This code example is part of the [Custom Tracking](/dotnet/framework/windows-workflow-foundation/samples/custom-tracking) sample. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet40"::: - + instance so they will be available to workflows invoked by it. + + + +## Examples + The following example registers a custom with the collection of a instance. This code example is part of the [Custom Tracking](/dotnet/framework/windows-workflow-foundation/samples/custom-tracking) sample. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet40"::: + ]]> @@ -410,11 +410,11 @@ Invokes a workflow synchronously and returns a dictionary of the root activity's and values keyed by argument name that represent the outputs of the workflow. - overloads that take a . - + overloads that take a . + ]]> @@ -439,24 +439,24 @@ Invokes a workflow synchronously using the workflow definition passed to the constructor. A dictionary of the root activity's and values keyed by argument name that represent the outputs of the workflow. - overloads that take a . - - - -## Examples - The following example invokes a workflow consisting of a single `DiceRoll` activity. The `DiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the call to `Invoke` returns, each output argument is returned in the outputs dictionary, keyed by argument name. The workflow is invoked twice, using the workflow definition passed into the `WorkflowInvoker` constructor. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet130"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet31"::: - - If the workflow's root activity has no output arguments or they are not needed by the host, they can be disregarded. The following example invokes a workflow consisting of a single activity that does not have any output arguments. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet2"::: - + overloads that take a . + + + +## Examples + The following example invokes a workflow consisting of a single `DiceRoll` activity. The `DiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the call to `Invoke` returns, each output argument is returned in the outputs dictionary, keyed by argument name. The workflow is invoked twice, using the workflow definition passed into the `WorkflowInvoker` constructor. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet130"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet31"::: + + If the workflow's root activity has no output arguments or they are not needed by the host, they can be disregarded. The following example invokes a workflow consisting of a single activity that does not have any output arguments. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet2"::: + ]]> @@ -484,24 +484,24 @@ Invokes a workflow synchronously using the specified workflow definition. A dictionary of the root activity's and values keyed by argument name that represent the outputs of the workflow. - overloads that take a . - - - -## Examples - The following example invokes a workflow consisting of a single `DiceRoll` activity. The `DiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the call to `Invoke` returns, each output argument is returned in the outputs dictionary, keyed by argument name. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet130"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet30"::: - - If the workflow's root activity has no output arguments or they are not needed by the host, they can be disregarded. The following example invokes a workflow consisting of a single activity that does not have any output arguments. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet1"::: - + overloads that take a . + + + +## Examples + The following example invokes a workflow consisting of a single `DiceRoll` activity. The `DiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the call to `Invoke` returns, each output argument is returned in the outputs dictionary, keyed by argument name. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet130"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet30"::: + + If the workflow's root activity has no output arguments or they are not needed by the host, they can be disregarded. The following example invokes a workflow consisting of a single activity that does not have any output arguments. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet1"::: + ]]> @@ -529,26 +529,26 @@ Invokes the activity passed to the constructor synchronously with the specified of input parameters. A dictionary of the root activity's and values keyed by argument name that represent the outputs of the workflow. - overloads that take a . - - - -## Examples - The following example invokes a workflow consisting of a single `Divide` activity that has two input arguments and two output arguments. When the workflow is invoked, the `arguments` dictionary is passed which contains the values for each input argument, keyed by argument name. When the call to `Invoke` returns, each output argument is returned in the `outputs` dictionary, also keyed by argument name. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet120"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet22"::: - - If the workflow derives from , such as `CodeActivity` or `Activity`, and there are output arguments in addition to the well-defined output argument, a non-generic overload of `Invoke`, such as this one, must be used in order to retrieve the additional arguments. To do this, the workflow definition passed into the `WorkflowInvoker` constructor must be of type . In this example the `Divide` activity derives from `CodeActivity`, but is declared as so that this overload of `Invoke`, which returns a dictionary of arguments instead of a single return value, is used. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet121"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet23"::: - + overloads that take a . + + + +## Examples + The following example invokes a workflow consisting of a single `Divide` activity that has two input arguments and two output arguments. When the workflow is invoked, the `arguments` dictionary is passed that contains the values for each input argument, keyed by argument name. When the call to `Invoke` returns, each output argument is returned in the `outputs` dictionary, also keyed by argument name. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet120"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet22"::: + + If the workflow derives from , such as `CodeActivity` or `Activity`, and there are output arguments in addition to the well-defined output argument, a non-generic overload of `Invoke`, such as this one, must be used in order to retrieve the additional arguments. To do this, the workflow definition passed into the `WorkflowInvoker` constructor must be of type . In this example the `Divide` activity derives from `CodeActivity`, but is declared as so that this overload of `Invoke`, which returns a dictionary of arguments instead of a single return value, is used. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet121"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet23"::: + ]]> @@ -576,28 +576,28 @@ Invokes a workflow synchronously with the specified time-out interval. A dictionary of the root activity's and values keyed by argument name that represent the outputs of the workflow. - is thrown. - + is thrown. + > [!NOTE] -> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. - - - -## Examples - The following example invokes a workflow that contains two activities and a activity configured with a of one minute. This workflow is invoked twice; the first time with a time-out interval of two minutes, and the second time with a time-out interval of 30 seconds. The first workflow completes successfully, but the second one does not and a is thrown and the following message is displayed. - -```Output -The operation did not complete within the allotted timeout of 00:00:30. -The time allotted to this operation may have been a portion of a longer timeout. -``` - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet51"::: - - For an example of using `Invoke` with output arguments, see the overload of with the same parameters as this overload without the time-out interval. - +> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. + + + +## Examples + The following example invokes a workflow that contains two activities and a activity configured with a of one minute. This workflow is invoked twice; the first time with a time-out interval of two minutes, and the second time with a time-out interval of 30 seconds. The first workflow completes successfully, but the second one does not and a is thrown and the following message is displayed. + +```Output +The operation did not complete within the allotted timeout of 00:00:30. +The time allotted to this operation may have been a portion of a longer timeout. +``` + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet51"::: + + For an example of using `Invoke` with output arguments, see the overload of with the same parameters as this overload without the time-out interval. + ]]> @@ -627,26 +627,26 @@ The time allotted to this operation may have been a portion of a longer timeout. Invokes a workflow synchronously using the specified workflow definition and of input parameters. A dictionary of the root activity's and values keyed by argument name that represent the outputs of the workflow. - overloads that take a . - - - -## Examples - The following example invokes a workflow consisting of a single `Divide` activity that has two input arguments and two output arguments. When the workflow is invoked, the `arguments` dictionary is passed which contains the values for each input argument, keyed by argument name. When the call to `Invoke` returns, each output argument is returned in the `outputs` dictionary, also keyed by argument name. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet120"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet20"::: - - If the workflow derives from , such as `CodeActivity` or `Activity`, and there are output arguments in addition to the well-defined output argument, a non-generic overload of `Invoke`, such as this one, must be used in order to retrieve the additional arguments. To do this, the workflow definition passed into `Invoke` must be of type . In this example the `Divide` activity derives from `CodeActivity`, but is declared as so that this overload of `Invoke`, which returns a dictionary of arguments instead of a single return value, is used. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet121"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet21"::: - + overloads that take a . + + + +## Examples + The following example invokes a workflow consisting of a single `Divide` activity that has two input arguments and two output arguments. When the workflow is invoked, the `arguments` dictionary is passed that contains the values for each input argument, keyed by argument name. When the call to `Invoke` returns, each output argument is returned in the `outputs` dictionary, also keyed by argument name. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet120"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet20"::: + + If the workflow derives from , such as `CodeActivity` or `Activity`, and there are output arguments in addition to the well-defined output argument, a non-generic overload of `Invoke`, such as this one, must be used in order to retrieve the additional arguments. To do this, the workflow definition passed into `Invoke` must be of type . In this example the `Divide` activity derives from `CodeActivity`, but is declared as so that this overload of `Invoke`, which returns a dictionary of arguments instead of a single return value, is used. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet121"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet21"::: + ]]> @@ -682,23 +682,23 @@ The time allotted to this operation may have been a portion of a longer timeout. Invokes a workflow synchronously using the specified workflow definition and time-out interval. A dictionary of the root activity's and values keyed by argument name that represent the outputs of the workflow. - is thrown. - + is thrown. + > [!NOTE] -> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. - - - -## Examples - The following example invokes a workflow that contains two activities and a activity configured with a of one minute. This workflow is invoked twice; the first time with a time-out interval of two minutes, and the second time with a time-out interval of 30 seconds. The first workflow completes successfully, but the second one does not and a is thrown. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet50"::: - - For an example of using `Invoke` with output arguments, see the overload of with the same parameters as this overload without the time-out interval. - +> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. + + + +## Examples + The following example invokes a workflow that contains two activities and a activity configured with a of one minute. This workflow is invoked twice; the first time with a time-out interval of two minutes, and the second time with a time-out interval of 30 seconds. The first workflow completes successfully, but the second one does not and a is thrown. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet50"::: + + For an example of using `Invoke` with output arguments, see the overload of with the same parameters as this overload without the time-out interval. + ]]> @@ -728,28 +728,28 @@ The time allotted to this operation may have been a portion of a longer timeout. Invokes the activity passed to the constructor synchronously with the specified of input parameters and the specified time-out interval. A dictionary of the root activity's and values keyed by argument name that represent the outputs of the workflow. - is thrown. - + is thrown. + > [!NOTE] -> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. - - - -## Examples - The following example invokes a workflow that contains two activities and a activity configured with a of one minute. This workflow is invoked twice; the first time with a time-out interval of two minutes, and the second time with a time-out interval of 30 seconds. The first workflow completes successfully, but the second one does not and a is thrown and the following message is displayed. - -```Output -The operation did not complete within the allotted timeout of 00:00:30. -The time allotted to this operation may have been a portion of a longer timeout. -``` - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet51"::: - - For an example of using `Invoke` with input and output arguments, see the overload of with the same parameters as this overload without the time-out interval. - +> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. + + + +## Examples + The following example invokes a workflow that contains two activities and a activity configured with a of one minute. This workflow is invoked twice; the first time with a time-out interval of two minutes, and the second time with a time-out interval of 30 seconds. The first workflow completes successfully, but the second one does not and a is thrown and the following message is displayed. + +```Output +The operation did not complete within the allotted timeout of 00:00:30. +The time allotted to this operation may have been a portion of a longer timeout. +``` + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet51"::: + + For an example of using `Invoke` with input and output arguments, see the overload of with the same parameters as this overload without the time-out interval. + ]]> @@ -787,23 +787,23 @@ The time allotted to this operation may have been a portion of a longer timeout. Invokes a workflow synchronously using the specified workflow definition, of input parameters, and time-out interval. A dictionary of the root activity's and values keyed by argument name that represent the outputs of the workflow. - is thrown. - + is thrown. + > [!NOTE] -> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. - - - -## Examples - The following example invokes a workflow that contains two activities and a activity configured with a of one minute. This workflow is invoked twice; the first time with a time-out interval of two minutes, and the second time with a time-out interval of 30 seconds. The first workflow completes successfully, but the second one does not and a is thrown. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet50"::: - - For an example of using `Invoke` with input and output arguments, see the overload of with the same parameters as this overload without the time-out interval. - +> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. + + + +## Examples + The following example invokes a workflow that contains two activities and a activity configured with a of one minute. This workflow is invoked twice; the first time with a time-out interval of two minutes, and the second time with a time-out interval of 30 seconds. The first workflow completes successfully, but the second one does not and a is thrown. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet50"::: + + For an example of using `Invoke` with input and output arguments, see the overload of with the same parameters as this overload without the time-out interval. + ]]> @@ -841,19 +841,19 @@ The time allotted to this operation may have been a portion of a longer timeout. Invokes a workflow synchronously using the workflow definition passed to the constructor. A value of type TResult with the result of the execution of the activity. - overloads that take a . ## Examples -The following example invokes a workflow consisting of a single `Add` activity that has two input arguments and since it derives from `CodeActivity` it has one well-defined output argument. When the workflow is invoked, the `arguments` dictionary is passed which contains the values for each input argument, keyed by argument name. When the call to `Invoke` returns, the value of the output argument is returned. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet110"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet10"::: - +The following example invokes a workflow consisting of a single `Add` activity that has two input arguments and since it derives from `CodeActivity` it has one well-defined output argument. When the workflow is invoked, the `arguments` dictionary is passed that contains the values for each input argument, keyed by argument name. When the call to `Invoke` returns, the value of the output argument is returned. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet110"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet10"::: + ]]> @@ -887,22 +887,22 @@ The following example invokes a workflow consisting of a single `Add` activity t Invokes a workflow synchronously using the specified workflow definition and of input parameters. A value of type TResult with the result of the execution of the activity. - overloads that take a . - + overloads that take a . + > [!NOTE] > The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete, completes successfully if the workflow does not become idle. ## Examples -The following example invokes a workflow consisting of a single `Add` activity that has two input arguments and since it derives from `CodeActivity` it has one well-defined output argument. When the workflow is invoked, the `arguments` dictionary is passed which contains the values for each input argument, keyed by argument name. When the call to `Invoke` returns, the value of the output argument is returned. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet110"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet10"::: - +The following example invokes a workflow consisting of a single `Add` activity that has two input arguments and since it derives from `CodeActivity` it has one well-defined output argument. When the workflow is invoked, the `arguments` dictionary is passed that contains the values for each input argument, keyed by argument name. When the call to `Invoke` returns, the value of the output argument is returned. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet110"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet10"::: + ]]> @@ -938,22 +938,22 @@ The following example invokes a workflow consisting of a single `Add` activity t Invokes a workflow synchronously using the specified workflow definition, of input parameters, and time-out interval. A value of type TResult with the result of the execution of the activity. - is thrown. - + is thrown. + > [!NOTE] > The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete, completes successfully if the workflow does not become idle. ## Examples -The following example invokes a workflow consisting of a single `Add` activity that has two input arguments and since it derives from `CodeActivity` it has one well-defined output argument. When the workflow is invoked, the `arguments` dictionary is passed which contains the values for each input argument, keyed by argument name. When the call to `Invoke` returns, the value of the output argument is returned. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet110"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet10"::: - +The following example invokes a workflow consisting of a single `Add` activity that has two input arguments and since it derives from `CodeActivity` it has one well-defined output argument. When the workflow is invoked, the `arguments` dictionary is passed that contains the values for each input argument, keyed by argument name. When the call to `Invoke` returns, the value of the output argument is returned. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet110"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet10"::: + ]]> @@ -991,22 +991,22 @@ The following example invokes a workflow consisting of a single `Add` activity t Invokes a workflow synchronously using the specified workflow definition, of input parameters, of additional output parameters, and time-out interval. A value of type TResult with the result of the execution of the activity. - is thrown. - + is thrown. + > [!NOTE] > The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete, completes successfully if the workflow does not become idle. ## Examples -The following example invokes a workflow consisting of a single `Add` activity that has two input arguments and since it derives from `CodeActivity` it has one well-defined output argument. When the workflow is invoked, the `arguments` dictionary is passed which contains the values for each input argument, keyed by argument name. When the call to `Invoke` returns, the value of the output argument is returned. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet110"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet10"::: - +The following example invokes a workflow consisting of a single `Add` activity that has two input arguments and since it derives from `CodeActivity` it has one well-defined output argument. When the workflow is invoked, the `arguments` dictionary is passed that contains the values for each input argument, keyed by argument name. When the call to `Invoke` returns, the value of the output argument is returned. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet110"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet10"::: + ]]> @@ -1019,13 +1019,13 @@ The following example invokes a workflow consisting of a single `Add` activity t Invokes a workflow asynchronously using the event-based asynchronous design pattern. - . To configure a time-out interval in which the workflow must complete, use one of the overloads that take a . - - This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](/dotnet/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview). - + . To configure a time-out interval in which the workflow must complete, use one of the overloads that take a . + + This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](/dotnet/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview). + ]]> @@ -1049,20 +1049,20 @@ The following example invokes a workflow consisting of a single `Add` activity t Invokes a workflow asynchronously. - . To configure a time-out interval in which the workflow must complete, use one of the overloads that take a . - - This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](/dotnet/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview). - + . To configure a time-out interval in which the workflow must complete, use one of the overloads that take a . + + This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](/dotnet/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview). + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - -## Examples - The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: - + +## Examples + The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: ]]> @@ -1097,20 +1097,20 @@ The following example invokes a workflow consisting of a single `Add` activity t The dictionary of input parameters to the workflow, keyed by argument name. Invokes a workflow asynchronously using the specified of input parameters. - . To configure a time-out interval in which the workflow must complete, use one of the overloads that take a . - + . To configure a time-out interval in which the workflow must complete, use one of the overloads that take a . + This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](/dotnet/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview). - + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - -## Examples - The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. - + +## Examples + The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: - + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: ]]> @@ -1139,24 +1139,24 @@ The following example invokes a workflow consisting of a single `Add` activity t A user-provided object used to distinguish this particular asynchronous invoke operation from other current asynchronous invoke operations. Invokes a workflow asynchronously using the specified unique identifier. - operations for the current activity. If the `userState` parameter is not unique, an is thrown. `userState` is used to identify the workflow in , and to cancel the workflow using . - - To be notified when the workflow is complete, handle . To configure a time-out interval in which the workflow must complete, use one of the overloads that take a . - - This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](/dotnet/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview). - - - -## Examples - The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: - + operations for the current activity. If the `userState` parameter is not unique, an is thrown. `userState` is used to identify the workflow in , and to cancel the workflow using . + + To be notified when the workflow is complete, handle . To configure a time-out interval in which the workflow must complete, use one of the overloads that take a . + + This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](/dotnet/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview). + + + +## Examples + The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: + ]]> @@ -1189,23 +1189,23 @@ The following example invokes a workflow consisting of a single `Add` activity t The interval in which the workflow must complete before it is aborted and a is thrown. Invokes a workflow asynchronously with the specified time-out interval. - . If the workflow does not complete within the specified time-out interval the workflow is aborted and a is thrown. - + . If the workflow does not complete within the specified time-out interval the workflow is aborted and a is thrown. + > [!NOTE] -> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. - - This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](/dotnet/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview). - +> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. + + This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](/dotnet/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview). + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - -## Examples - The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: - + +## Examples + The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: ]]> @@ -1236,24 +1236,24 @@ The following example invokes a workflow consisting of a single `Add` activity t A user-provided object used to distinguish this particular asynchronous invoke operation from other current asynchronous invoke operations. Invokes a workflow asynchronously using the specified of input parameters and a unique identifier. - operations for the current activity. If `userState` is not unique, an is thrown. `userState` is used to identify the workflow in , and to cancel the workflow using . - - To be notified when the workflow is complete, handle . To configure a time-out interval in which the workflow must complete, use one of the overloads that take a . - - This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](/dotnet/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview). - - - -## Examples - The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: - + operations for the current activity. If `userState` is not unique, an is thrown. `userState` is used to identify the workflow in , and to cancel the workflow using . + + To be notified when the workflow is complete, handle . To configure a time-out interval in which the workflow must complete, use one of the overloads that take a . + + This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](/dotnet/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview). + + + +## Examples + The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: + ]]> @@ -1288,23 +1288,23 @@ The following example invokes a workflow consisting of a single `Add` activity t The interval in which the workflow must complete before it is aborted and a is thrown. Invokes a workflow asynchronously with the specified of input parameters and the specified time-out interval. - . If the workflow does not complete within the specified time-out interval the workflow is aborted and a is thrown. - + . If the workflow does not complete within the specified time-out interval the workflow is aborted and a is thrown. + > [!NOTE] -> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. - +> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. + This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](/dotnet/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview). - + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - -## Examples - The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: - + +## Examples + The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: ]]> @@ -1335,27 +1335,27 @@ This method stores in the task it returns all non-usage exceptions that the meth A user-provided object used to distinguish this particular asynchronous invoke operation from other current asynchronous invoke operations. Invokes a workflow asynchronously with the specified time-out interval and a unique identifier. - operations for the current activity. If `userState` is not unique, an is thrown. `userState` is used to identify the workflow in , and to cancel the workflow using . - - To be notified when the workflow is complete, handle . If the workflow does not complete within the specified time-out interval the workflow is aborted and a is thrown. - + operations for the current activity. If `userState` is not unique, an is thrown. `userState` is used to identify the workflow in , and to cancel the workflow using . + + To be notified when the workflow is complete, handle . If the workflow does not complete within the specified time-out interval the workflow is aborted and a is thrown. + > [!NOTE] -> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. - - This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](/dotnet/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview). - - - -## Examples - The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: - +> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. + + This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](/dotnet/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview). + + + +## Examples + The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: + ]]> @@ -1386,27 +1386,27 @@ This method stores in the task it returns all non-usage exceptions that the meth A user-provided object used to distinguish this particular asynchronous invoke operation from other current asynchronous invoke operations. Invokes a workflow asynchronously with the specified of input parameters, the specified time-out interval, and a unique identifier. - operations for the current activity. If `userState` is not unique, an is thrown. `userState` is used to identify the workflow in , and to cancel the workflow using . - - To be notified when the workflow is complete, handle . If the workflow does not complete within the specified time-out interval the workflow is aborted and a is thrown. - + operations for the current activity. If `userState` is not unique, an is thrown. `userState` is used to identify the workflow in , and to cancel the workflow using . + + To be notified when the workflow is complete, handle . If the workflow does not complete within the specified time-out interval the workflow is aborted and a is thrown. + > [!NOTE] -> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. - - This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](/dotnet/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview). - - - -## Examples - The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: - +> The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. + + This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](/dotnet/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview). + + + +## Examples + The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: + ]]> @@ -1430,20 +1430,20 @@ This method stores in the task it returns all non-usage exceptions that the meth Occurs when the workflow invoked by one of the overloads is completed or canceled. - overloads completed successfully and to retrieve the output arguments of the completed workflow. - - - -## Examples - The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: - + overloads completed successfully and to retrieve the output arguments of the completed workflow. + + + +## Examples + The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: + ]]> diff --git a/xml/System.CodeDom.Compiler/CodeGenerator.xml b/xml/System.CodeDom.Compiler/CodeGenerator.xml index 291fc1d0f51..e99d71cddf0 100644 --- a/xml/System.CodeDom.Compiler/CodeGenerator.xml +++ b/xml/System.CodeDom.Compiler/CodeGenerator.xml @@ -37,14 +37,14 @@ Provides an example implementation of the interface. This class is abstract. - [!NOTE] -> This class contains a link demand and an inheritance demand at the class level that applies to all members. A is thrown when either the immediate caller or the derived class does not have full-trust permission. For details about security demands, see [Link Demands](/dotnet/framework/misc/link-demands) and [Inheritance Demands](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/x4yx82e6(v=vs.100)). - +> This class contains a link demand and an inheritance demand at the class level that applies to all members. A is thrown when either the immediate caller or the derived class does not have full-trust permission. For details about security demands, see [Link Demands](/dotnet/framework/misc/link-demands) and [Inheritance Demands](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/x4yx82e6(v=vs.100)). + ]]> @@ -163,14 +163,14 @@ Creates an escaped identifier for the specified value. The escaped identifier for the value. - tests whether the identifier conflicts with reserved or language keywords, and if so, returns an equivalent name with language-specific escape code formatting. The returned name is referred to an escaped identifier. The escaped identifier contains the same `value` but includes escape code formatting to differentiate it from conflicting keywords. For example, `value` could be preceded by an at sign ("@") or delimited by square brackets ("[" and "]") to create an escaped identifier. - + tests whether the identifier conflicts with reserved or language keywords, and if so, returns an equivalent name with language-specific escape code formatting. The returned name is referred to an escaped identifier. The escaped identifier contains the same `value` but includes escape code formatting to differentiate it from conflicting keywords. For example, `value` could be preceded by an at sign ("@") or delimited by square brackets ("[" and "]") to create an escaped identifier. + > [!NOTE] -> The default implementation of this method does nothing. - +> The default implementation of this method does nothing. + ]]> @@ -212,14 +212,14 @@ Creates a valid identifier for the specified value. A valid identifier for the value. - tests whether the identifier conflicts with reserved or language keywords, and if so, returns a valid identifier name that does not conflict. The returned identifier contains the same `value` but includes escape code formatting to differentiate it from conflicting keywords. Typically, if the value requires modification, it is preceded by an underscore "_". - + tests whether the identifier conflicts with reserved or language keywords, and if so, returns a valid identifier name that does not conflict. The returned identifier contains the same `value` but includes escape code formatting to differentiate it from conflicting keywords. Typically, if the value requires modification, it is preceded by an underscore "_". + > [!NOTE] -> The default implementation of this method does nothing. - +> The default implementation of this method does nothing. + ]]> @@ -794,11 +794,11 @@ The options to use when generating the code. Generates code for the specified class member using the specified text writer and code generator options. - The property is not . @@ -1071,11 +1071,11 @@ The statement to generate code for. Generates code for the specified conditional statement. - @@ -1769,11 +1769,11 @@ The statement to generate code for. Generates code for the specified iteration statement. - @@ -2388,26 +2388,26 @@ Generates code for the specified primitive expression. To be added. - uses an invalid data type. Only the following data types are valid: - -- string - -- char - -- byte - -- Int16 - -- Int32 - -- Int64 + uses an invalid data type. Only the following data types are valid: + +- string + +- char + +- byte + +- Int16 + +- Int32 + +- Int64 - Half - -- Single - -- Double - + +- Single + +- Double + - Decimal @@ -3331,11 +3331,11 @@ Gets or sets the amount of spaces to indent each indentation level. The number of spaces to indent for each indentation level. - @@ -3597,11 +3597,11 @@ if the specified string is a valid identifier; otherwise, . - method calls this method to perform string validation. Calling the method and passing a before generating code from it can prevent the use of certain character sequences to include hidden code within an identifier field. - + method calls this method to perform string validation. Calling the method and passing a before generating code from it can prevent the use of certain character sequences to include hidden code within an identifier field. + ]]> @@ -4313,11 +4313,11 @@ Converts the specified string by formatting it with escape codes. The converted string. - @@ -4948,15 +4948,15 @@ An object to test for invalid identifiers. Attempts to validate each identifier field contained in the specified or tree. - objects to contain field escape characters and hidden code which can allow security violations. This method checks the literal fields of each in a tree for characters which could be used to hide code, and throws an exception if an identifier field contains an invalid character. - - This method calls the method to validate each identifier in the specified or tree, and throws an exception if an identifier is invalid or contains invalid characters. - - Call this method and pass it the containing the code graph to generate before generating code to block the use of certain character sequences that can be used to include hidden code within an identifier field. This method is not called automatically by any generate code methods. - + objects to contain field escape characters and hidden code, which can allow security violations. This method checks the literal fields of each in a tree for characters which could be used to hide code, and throws an exception if an identifier field contains an invalid character. + + This method calls the method to validate each identifier in the specified or tree, and throws an exception if an identifier is invalid or contains invalid characters. + + Call this method and pass it the containing the code graph to generate before generating code to block the use of certain character sequences that can be used to include hidden code within an identifier field. This method is not called automatically by any generate code methods. + ]]> The specified contains an invalid identifier. diff --git a/xml/System.CodeDom.Compiler/CompilerError.xml b/xml/System.CodeDom.Compiler/CompilerError.xml index e353109959f..689e6be3d65 100644 --- a/xml/System.CodeDom.Compiler/CompilerError.xml +++ b/xml/System.CodeDom.Compiler/CompilerError.xml @@ -40,23 +40,23 @@ Represents a compiler error or warning. - represents a compiler error or a warning that has been returned by the compiler. - + represents a compiler error or a warning that has been returned by the compiler. + > [!NOTE] -> This class contains an inheritance demand at the class level that applies to all members. A is thrown when the derived class does not have full-trust permission. For details about inheritance demands, see [Inheritance Demands](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/x4yx82e6(v=vs.100)). - - - -## Examples - The following example compiles a CodeDOM program graph and provides an example of how to programmatically access CompilerError data. - +> This class contains an inheritance demand at the class level that applies to all members. A is thrown when the derived class does not have full-trust permission. For details about inheritance demands, see [Inheritance Demands](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/x4yx82e6(v=vs.100)). + + + +## Examples + The following example compiles a CodeDOM program graph and provides an example of how to programmatically access CompilerError data. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_Classic/classic CompilerError Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/CompilerError/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_Classic/classic CompilerError Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_Classic/classic CompilerError Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -191,11 +191,11 @@ Gets or sets the column number where the source of the error occurs. The column number of the source file where the compiler encountered the error. - property can be set to zero for compilers that do not return column information. - + property can be set to zero for compilers that do not return column information. + ]]> @@ -242,11 +242,11 @@ Gets or sets the error number. The error number as a string. - property can contain a string of any length. - + property can contain a string of any length. + ]]> @@ -293,11 +293,11 @@ Gets or sets the text of the error message. The text of the error message. - property can be a string of any length. - + property can be a string of any length. + ]]> @@ -341,8 +341,8 @@ System.String - Gets or sets the file name of the source file that contains the code which caused the error. - The file name of the source file that contains the code which caused the error. + Gets or sets the file name of the source file that contains the code that caused the error. + The file name of the source file that contains the code that caused the error. To be added. @@ -468,11 +468,11 @@ Provides an implementation of Object's method. A string representation of the compiler error. - objects can be treated as objects for simplified debugging output. - + objects can be treated as objects for simplified debugging output. + ]]> diff --git a/xml/System.DirectoryServices.ActiveDirectory/AdamInstance.xml b/xml/System.DirectoryServices.ActiveDirectory/AdamInstance.xml index 36abf21bc13..3e4e63b040b 100644 --- a/xml/System.DirectoryServices.ActiveDirectory/AdamInstance.xml +++ b/xml/System.DirectoryServices.ActiveDirectory/AdamInstance.xml @@ -26,13 +26,13 @@ The class represents an AD LDS instance server. - [!NOTE] -> The class refers to Active Directory Application Mode (ADAM) which has been renamed to Active Directory Lightweight Directory Services (AD LDS). - +> The class refers to Active Directory Application Mode (ADAM), which has been renamed to Active Directory Lightweight Directory Services (AD LDS). + ]]> @@ -60,11 +60,11 @@ Invokes the Knowledge Consistency Checker (KCC) that verifies the replication topology for this AD LDS instance. - A call to the underlying directory service resulted in an error. @@ -288,13 +288,13 @@ Returns an AD LDS instance for a specified context. An object that refers to the AD LDS instance that is found. - [!NOTE] -> The method refers to Active Directory Application Mode (ADAM) which has been renamed to Active Directory Lightweight Directory Services (AD LDS). - +> The method refers to Active Directory Application Mode (ADAM), which has been renamed to Active Directory Lightweight Directory Services (AD LDS). + ]]> A connection to the target that was specified in the parameter could not be made. diff --git a/xml/System.DirectoryServices.ActiveDirectory/AdamInstanceCollection.xml b/xml/System.DirectoryServices.ActiveDirectory/AdamInstanceCollection.xml index 39e9b24918f..75e8c029745 100644 --- a/xml/System.DirectoryServices.ActiveDirectory/AdamInstanceCollection.xml +++ b/xml/System.DirectoryServices.ActiveDirectory/AdamInstanceCollection.xml @@ -26,13 +26,13 @@ The class is a read-only collection that contains objects. - [!NOTE] -> The class refers to Active Directory Application Mode (ADAM) which has been renamed to Active Directory Lightweight Directory Services (AD LDS). - +> The class refers to Active Directory Application Mode (ADAM), which has been renamed to Active Directory Lightweight Directory Services (AD LDS). + ]]> diff --git a/xml/System.DirectoryServices.ActiveDirectory/AdamRole.xml b/xml/System.DirectoryServices.ActiveDirectory/AdamRole.xml index 206980adf4b..0badc9e4920 100644 --- a/xml/System.DirectoryServices.ActiveDirectory/AdamRole.xml +++ b/xml/System.DirectoryServices.ActiveDirectory/AdamRole.xml @@ -19,13 +19,13 @@ Indicates specific roles of a object. - [!NOTE] -> The class refers to Active Directory Application Mode (ADAM) which has been renamed to Active Directory Lightweight Directory Services (AD LDS). - +> The class refers to Active Directory Application Mode (ADAM), which has been renamed to Active Directory Lightweight Directory Services (AD LDS). + ]]> diff --git a/xml/System.DirectoryServices.ActiveDirectory/AdamRoleCollection.xml b/xml/System.DirectoryServices.ActiveDirectory/AdamRoleCollection.xml index c0d42efeadf..f6835550dc1 100644 --- a/xml/System.DirectoryServices.ActiveDirectory/AdamRoleCollection.xml +++ b/xml/System.DirectoryServices.ActiveDirectory/AdamRoleCollection.xml @@ -20,13 +20,13 @@ The class is a read-only collection that contains items. - [!NOTE] -> The class refers to Active Directory Application Mode (ADAM) which has been renamed to Active Directory Lightweight Directory Services (AD LDS). - +> The class refers to Active Directory Application Mode (ADAM), which has been renamed to Active Directory Lightweight Directory Services (AD LDS). + ]]> diff --git a/xml/System.DirectoryServices.Protocols/LdapConnection.xml b/xml/System.DirectoryServices.Protocols/LdapConnection.xml index 808a3145b35..b103e2328b2 100644 --- a/xml/System.DirectoryServices.Protocols/LdapConnection.xml +++ b/xml/System.DirectoryServices.Protocols/LdapConnection.xml @@ -88,7 +88,7 @@ - A string specifying the server which can be a domain name, LDAP server name or dotted strings representing the IP address of the LDAP server. Optionally, this parameter may also include a port number, separated from the right end of the string by a colon (:). + A string specifying the server, which can be a domain name, LDAP server name, or dotted strings representing the IP address of the LDAP server. Optionally, this parameter can also include a port number, separated from the right end of the string by a colon (:). The constructor creates an instance of the class using the specified server. To be added. Failed to create a connection block or to open a connection to server. diff --git a/xml/System.EnterpriseServices/ServiceConfig.xml b/xml/System.EnterpriseServices/ServiceConfig.xml index 31d6c54d462..00bd98f0a4b 100644 --- a/xml/System.EnterpriseServices/ServiceConfig.xml +++ b/xml/System.EnterpriseServices/ServiceConfig.xml @@ -24,11 +24,11 @@ Specifies and configures the services that are to be active in the domain which is entered when calling or creating an . This class cannot be inherited. - and allow you to use the services configured by with no need to tie those services to a component. - + and allow you to use the services configured by with no need to tie those services to a component. + ]]> @@ -50,34 +50,34 @@ Initializes a new instance of the class, setting the properties to configure the desired services. - . - -|Item|Description| -|----------|-----------------| -|`Binding`|| -|`BringYourOwnTransaction`|`null`| -|`COMTIIntrinsicsEnabled`|`false`| -|`IISIntrinsicsEnabled`|`false`| -|`Inheritance`|| -|`IsolationLevel`|| -|`PartitionId`|A zero GUID.| -|`PartitionOption`|| -|`SxsDirectory`|`null`| -|`SxsName`|`null`| -|`SxsOption`|| -|`Synchronization`|| -|`ThreadPool`|| -|`TipUrl`|`null`| -|`TrackingAppName`|`null`| -|`TrackingComponentName`|`null`| -|`TrackingEnabled`|`false`| -|`Transaction`|| -|`TransactionDescription`|`null`| -|`TransactionTimeout`|The system default| - + . + +|Item|Description| +|----------|-----------------| +|`Binding`|| +|`BringYourOwnTransaction`|`null`| +|`COMTIIntrinsicsEnabled`|`false`| +|`IISIntrinsicsEnabled`|`false`| +|`Inheritance`|| +|`IsolationLevel`|| +|`PartitionId`|A zero GUID.| +|`PartitionOption`|| +|`SxsDirectory`|`null`| +|`SxsName`|`null`| +|`SxsOption`|| +|`Synchronization`|| +|`ThreadPool`|| +|`TipUrl`|`null`| +|`TrackingAppName`|`null`| +|`TrackingComponentName`|`null`| +|`TrackingEnabled`|`false`| +|`Transaction`|| +|`TransactionDescription`|`null`| +|`TransactionTimeout`|The system default| + ]]> @@ -105,11 +105,11 @@ Gets or sets the binding option, which indicates whether all work submitted by the activity is to be bound to only one single-threaded apartment (STA). One of the values. The default is . - has no impact on the multithreaded apartment (MTA). This property is used to set the thread pool binding only when creating a . An error is returned if an attempt is made to set the thread pool binding when calling . - + has no impact on the multithreaded apartment (MTA). This property is used to set the thread pool binding only when creating a . An error is returned if an attempt is made to set the thread pool binding when calling . + ]]> @@ -134,13 +134,13 @@ Gets or sets a that represents an existing transaction that supplies the settings used to run the transaction identified by . A . The default is . - (BYOT) identifies a transaction that supplies the context for the transaction. When you bring your own transaction, that transaction's settings override the other transaction settings in the object. The default value for is `null`. - - For more information on BYOT, see . - + (BYOT) identifies a transaction that supplies the context for the transaction. When you bring your own transaction, that transaction's settings override the other transaction settings in the object. The default value for is `null`. + + For more information on BYOT, see . + ]]> @@ -167,13 +167,13 @@ Gets or sets a that represents an existing transaction that supplies the settings used to run the transaction identified by . An . The default is . - (BYOT) identifies a transaction that supplies the context for the transaction. When you bring your own transaction, that transaction's settings override the other transaction settings in the object. The default value for is `null`. - - For more information on BYOT, see . - + (BYOT) identifies a transaction that supplies the context for the transaction. When you bring your own transaction, that transaction's settings override the other transaction settings in the object. The default value for is `null`. + + For more information on BYOT, see . + ]]> @@ -201,13 +201,13 @@ if COMTI intrinsics are enabled; otherwise, . The default is . - @@ -234,11 +234,11 @@ if IIS intrinsics are enabled; otherwise, . The default is . - @@ -287,11 +287,11 @@ Gets or sets the isolation level of the transaction. One of the values. The default is . - is ignored if the enclosed code would not otherwise run in a transaction. - + is ignored if the enclosed code would not otherwise run in a transaction. + ]]> @@ -363,13 +363,13 @@ Gets or sets the directory for the side-by-side assembly for the enclosed work. The name of the directory to be used for the side-by-side assembly. The default value is . - . - - You must set the property, if you create a new side-by-side assembly by setting the property to . - + . + + You must set the property, if you create a new side-by-side assembly by setting the property to . + ]]> @@ -461,7 +461,7 @@ System.EnterpriseServices.ThreadPoolOption - Gets or sets a value that indicates the thread pool which runs the work submitted by the activity. + Gets or sets a value that indicates the thread pool that runs the work submitted by the activity. One of the values. The default is . To be added. @@ -487,11 +487,11 @@ Gets or sets the Transaction Internet Protocol (TIP) URL that allows the enclosed code to run in an existing transaction. A TIP URL. The default value is . - is similar to the property but allows the enclosed code to run as an existing transaction that is specified by a TIP URL. - + is similar to the property but allows the enclosed code to run as an existing transaction that is specified by a TIP URL. + ]]> @@ -517,13 +517,13 @@ Gets or sets a text string that corresponds to the application ID under which tracker information is reported. The application ID under which tracker information is reported. The default value is . - . - - For more information, see . - + . + + For more information, see . + ]]> @@ -575,11 +575,11 @@ if tracking is enabled; otherwise, . The default is . - @@ -628,11 +628,11 @@ Gets or sets the name that is used when transaction statistics are displayed. The name used when transaction statistics are displayed. The default value is . - is used to describe the transaction. - + is used to describe the transaction. + ]]> diff --git a/xml/System.IdentityModel.Protocols.WSTrust/RequestClaim.xml b/xml/System.IdentityModel.Protocols.WSTrust/RequestClaim.xml index 7b913b42e33..2bb2a01fe9d 100644 --- a/xml/System.IdentityModel.Protocols.WSTrust/RequestClaim.xml +++ b/xml/System.IdentityModel.Protocols.WSTrust/RequestClaim.xml @@ -16,15 +16,15 @@ Represents a single requested claim in a security token request (RST). - which is a collection of objects. The contents of the wst:Claims element is accessed through the property. - - A object represents a request for a claim, identified by its claim type (the property), to be present in the security token issued by the STS. The property indicates whether the claim is required in the issued token. - - For more information about the element that this class represents, see the version of the WS-Trust specification that applies to your scenario. - + , which is a collection of objects. The contents of the wst:Claims element is accessed through the property. + + A object represents a request for a claim, identified by its claim type (the property), to be present in the security token issued by the STS. The property indicates whether the claim is required in the issued token. + + For more information about the element that this class represents, see the version of the WS-Trust specification that applies to your scenario. + ]]> @@ -57,11 +57,11 @@ The URI that represents the claim type. Initializes a new instance of the class with the specified claim type. - property is set to `false` and the property is set to `null` in the new instance. This constructor creates a object that represents a request for a claim that is required in the response. - + property is set to `false` and the property is set to `null` in the new instance. This constructor creates a object that represents a request for a claim that is required in the response. + ]]> @@ -88,11 +88,11 @@ if the claim is optional in the response; otherwise, . Initializes a new instance of the class with the specified claim type and a value that indicates whether the claim is optional. - property is set to `null` in the new instance. - + property is set to `null` in the new instance. + ]]> @@ -142,11 +142,11 @@ Gets the type of the requested claim. The URI that represents the claim type. - @@ -171,11 +171,11 @@ if the claim is optional in the response; otherwise, . - @@ -199,11 +199,11 @@ Gets or sets the requested claim value. The value of the claim. - diff --git a/xml/System.IdentityModel.Protocols.WSTrust/RequestedProofToken.xml b/xml/System.IdentityModel.Protocols.WSTrust/RequestedProofToken.xml index 61c73a61e83..25e61ac49af 100644 --- a/xml/System.IdentityModel.Protocols.WSTrust/RequestedProofToken.xml +++ b/xml/System.IdentityModel.Protocols.WSTrust/RequestedProofToken.xml @@ -16,13 +16,13 @@ Represents the contents of a wst:RequestedProofToken element. - property contains the key. If the security token is a regular token, such as a SCT, then its session key will be the material which gets encrypted. When the wst:RequestedProofToken contains only a wst:ComputedKey element as in the case of combined entropy, the property holds its contents. - - For more information about the element that this class represents, see the version of the WS-Trust specification that applies to your scenario. - + property contains the key. If the security token is a regular token, such as a SCT, then its session key will be the material that gets encrypted. When the wst:RequestedProofToken contains only a wst:ComputedKey element as in the case of combined entropy, the property holds its contents. + + For more information about the element that this class represents, see the version of the WS-Trust specification that applies to your scenario. + ]]> @@ -55,11 +55,11 @@ An array of that contains the key material. Initializes a new instance of the class using the specified key material. - @@ -106,11 +106,11 @@ A string that contains a URI that indicates the algorithm used to compute the session key in the combined entropy case. Initializes a new instance of the class using the specified computed key algorithm. - @@ -138,11 +138,11 @@ A that represents the credentials used to encrypt the key material. Initializes a new instance of the class using the specified key material and encrypting credentials. - @@ -166,11 +166,11 @@ Gets the computed key algorithm used to calculate the session key in the combined entropy case. A string that contains a URI that indicates the computed key algorithm. - @@ -194,11 +194,11 @@ Gets the key in the case when the wst:RequestedProofToken element contains a key. A that represents the key, which can be either encrypted or clear text. - diff --git a/xml/System.IdentityModel.Tokens/Saml2SecurityTokenHandler.xml b/xml/System.IdentityModel.Tokens/Saml2SecurityTokenHandler.xml index 15874f00eca..effe60de2a3 100644 --- a/xml/System.IdentityModel.Tokens/Saml2SecurityTokenHandler.xml +++ b/xml/System.IdentityModel.Tokens/Saml2SecurityTokenHandler.xml @@ -16,15 +16,15 @@ Represents a security token handler that creates security tokens from SAML 2.0 Assertions. - class serializes and deserializes security tokens backed by SAML 2.0 Assertions into objects. Security token handlers are responsible for creating, reading, writing, and validating tokens. - - You can configure a security token service (STS) or relying party (RP) application to process SAML 2.0 Assertion-backed security tokens by adding an instance of the class to the object configured for the service (or application). This can be done either programmatically or in the configuration file. The handler itself is configured from the configuration specified for the collection through the collection's property when it is added to the collection. While it is possible to configure the handler individually by setting its property, this is not normally necessary; however, if the handler must be configured individually, the property should be set after the handler is added to the collection. - - For many scenarios, the class can be used as-is; however, the class provides many extension points through the methods it exposes. By deriving from the and overriding specific methods, you can modify the functionality of the token processing provided in the default implementation, or you can add processing for extensions to the SAML Assertion specification that may be needed in some custom scenarios. - + class serializes and deserializes security tokens backed by SAML 2.0 Assertions into objects. Security token handlers are responsible for creating, reading, writing, and validating tokens. + + You can configure a security token service (STS) or relying party (RP) application to process SAML 2.0 Assertion-backed security tokens by adding an instance of the class to the object configured for the service (or application). This can be done either programmatically or in the configuration file. The handler itself is configured from the configuration specified for the collection through the collection's property when it is added to the collection. While it is possible to configure the handler individually by setting its property, this is not normally necessary; however, if the handler must be configured individually, the property should be set after the handler is added to the collection. + + For many scenarios, the class can be used as-is; however, the class provides many extension points through the methods it exposes. By deriving from the and overriding specific methods, you can modify the functionality of the token processing provided in the default implementation, or you can add processing for extensions to the SAML Assertion specification that may be needed in some custom scenarios. + ]]> @@ -55,11 +55,11 @@ Initializes a new instance of the class with default security token requirements. - property is set to an instance of that is crated with the parameterless constructor. - + property is set to an instance of that is crated with the parameterless constructor. + ]]> @@ -115,10 +115,10 @@ Adds all of the delegates associated with the subject into the attribute collection. To be added. - is . - - -or- - + is . + + -or- + is . @@ -194,11 +194,11 @@ , which indicates that the handler can validate tokens of type . - @@ -247,13 +247,13 @@ Gets a value that indicates whether this handler can serialize tokens of type . - ; which indicates that the handler can serialize tokens of type . + , which indicates that the handler can serialize tokens of type . - @@ -327,11 +327,11 @@ Creates a object for the assertion. A object. The default is . - @@ -390,11 +390,11 @@ Creates a object from a token descriptor. A that contains the converted claims. - @@ -425,15 +425,15 @@ A to add to the assertion being created or to ignore the object (and not create a SAML 2.0 authentication statement). To be added. - is . - - -or- - + is . + + -or- + The property of is . - The subject of the (the property) contains claims with a claim type of either or but does not contain at least one claim of each type. - - -or- - + The subject of the (the property) contains claims with a claim type of either or but does not contain at least one claim of each type. + + -or- + The authentication method specified by the subject of the cannot be resolved to an absolute URI. @@ -494,13 +494,13 @@ Creates the conditions for the assertion. A object that contains the conditions for the assertion. - property of the `tokenDescriptor`. It will also generate an AudienceRestrictionCondition limiting consumption of the assertion to the property of the `tokenDescriptor`. - + property of the `tokenDescriptor`. It will also generate an AudienceRestrictionCondition limiting consumption of the assertion to the property of the `tokenDescriptor`. + ]]> @@ -528,13 +528,13 @@ Creates a name identifier that identifies the assertion issuer. A that represents the name identifier. - property of the `tokenDescriptor`. - + property of the `tokenDescriptor`. + ]]> @@ -620,11 +620,11 @@ Creates SAML 2.0 statements to be included in the assertion. An enumeration of that contains the statements. - @@ -708,11 +708,11 @@ Builds an XML formatted string from a collection of SAML 2.0 attributes that represent the Actor. A well-formed XML string constructed using the attributes. - \\...\, ...\...\" - + \\...\, ...\...\" + ]]> @@ -764,19 +764,19 @@ A that represents the SAML 2.0 security token (the token should be of type ) to be checked. Throws an exception if the specified token already exists in the token replay cache; otherwise the token is added to the cache. - object configured for this handler through the property of the object referenced through the property. - + object configured for this handler through the property of the object referenced through the property. + ]]> is . - The property is . - - -or- - + The property is . + + -or- + There is no configured under the property of the handler configuration (accessed through the property). cannot be cast as an instance of . @@ -832,11 +832,11 @@ Gets the token encrypting credentials. Override this method to change the token encrypting credentials. An that represents the token encrypting credentials. - property of the `tokenDescriptor`. - + property of the `tokenDescriptor`. + ]]> @@ -867,13 +867,13 @@ Gets the credentials for signing the assertion. A that represents the credentials for signing the assertion. - property of the `tokenDescriptor` to retrieve the credentials. - + property of the `tokenDescriptor` to retrieve the credentials. + ]]> @@ -903,15 +903,15 @@ Returns the time until which the token should be held in the token replay cache. A that represents the expiration time. - ) than Configuration.TokenReplayCacheExpirationPeriod. - + ) than Configuration.TokenReplayCacheExpirationPeriod. + ]]> @@ -959,11 +959,11 @@ Gets or sets the security token serializer that is used to serialize and deserialize key identifiers. A that represents the serializer. - objects. - + objects. + ]]> An attempt to set the value to occurs. @@ -1047,18 +1047,18 @@ The issuer. Creates claims from a SAML 2.0 attribute statement and adds them to the specified subject. - - is . - - -or- - + is . + + -or- + is . @@ -1089,10 +1089,10 @@ Creates claims from a SAML 2.0 authentication statement and adds them to the specified subject. To be added. - is . - - -or- - + is . + + -or- + is . @@ -1122,11 +1122,11 @@ The issuer. Creates claims from a SAML 2.0 authorization decision statement and adds them to the specified subject. - @@ -1158,10 +1158,10 @@ Creates claims from the SAML 2.0 subject and adds them to the specified subject. To be added. - is . - - -or- - + is . + + -or- + is . @@ -1245,11 +1245,11 @@ Reads the <saml:Advice> element. A that represents the Advice element that is read. - @@ -1306,11 +1306,11 @@ Reads the <saml:Attribute> element. A that represents the Assertion element that is read. - @@ -1423,11 +1423,11 @@ Reads the <saml:AuthnContext> element. A that represents the AuthnContext element that is read. - element. To handle by-value authentication context declarations, override this method. - + element. To handle by-value authentication context declarations, override this method. + ]]> @@ -1511,11 +1511,11 @@ Reads the <saml:Conditions> element. A that represents the Conditions element that is read. - elements, override this method. - + elements, override this method. + ]]> @@ -1711,11 +1711,11 @@ Reads the <saml:ProxyRestriction> element, or a <saml:Condition> element that specifies an xsi:type of saml:ProxyRestrictionType. A that represents the element that was read. - @@ -1774,11 +1774,11 @@ Reads the <saml:Statement> element. A that represents the Statement element that was read. - @@ -1808,11 +1808,11 @@ Reads the <saml:Subject> element. A that represents the Subject element that was read. - element. To handle encrypted IDs in the Subject, override this method. - + element. To handle encrypted IDs in the Subject, override this method. + ]]> @@ -1869,11 +1869,11 @@ Reads the <saml:SubjectConfirmationData> element. A that represents the SubjectConfirmationData element that was read. - @@ -1986,14 +1986,14 @@ Reads a SAML 2.0 token from the specified stream. An instance of . To be added. - The property is . - - -or- - - The property of the configuration specified by the property is . - - -or- - + The property is . + + -or- + + The property of the configuration specified by the property is . + + -or- + The property of the configuration specified by the property is . @@ -2205,11 +2205,11 @@ to check for Audience Restriction condition. Validates the specified object. - @@ -2236,11 +2236,11 @@ The SAML 2.0 subject confirmation data. Validates the specified object. - @@ -2268,11 +2268,11 @@ Validates the token data and returns its claims. The identities contained in the token. - @@ -2302,10 +2302,10 @@ Writes the <saml:Action> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2334,10 +2334,10 @@ Writes the <saml:Advice> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2366,19 +2366,19 @@ Serializes the specified SAML assertion to the specified XML writer. To be added. - is . - - -or- - + is . + + -or- + is . - The property of the assertion specified by is either or has no elements. - - -or- - - There are no statements and no subject in the assertion specified by . (Both the property and the property are .) If an assertion does not contain statements, it must contain a subject. - - -or- - + The property of the assertion specified by is either or has no elements. + + -or- + + There are no statements and no subject in the assertion specified by . (Both the property and the property are .) If an assertion does not contain statements, it must contain a subject. + + -or- + The assertion specified by contains an authentication, attribute, or authorization decision statement and no subject - these statements require a subject. (The property contains a statement of type , , or and the property is ). The token encrypting credentials do not have a Symmetric Key specified. @@ -2408,10 +2408,10 @@ Writes the <saml:Attribute> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2440,10 +2440,10 @@ Writes the <saml:AttributeStatement> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2473,11 +2473,11 @@ A that represents the attribute whose value is being written. Writes the saml:Attribute value. - @@ -2509,10 +2509,10 @@ Writes the <saml:AudienceRestriction> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2541,10 +2541,10 @@ Writes the <saml:AuthnContext> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2573,10 +2573,10 @@ Writes the <saml:AuthnStatement> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2605,10 +2605,10 @@ Writes the <saml:AuthzDecisionStatement> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2637,10 +2637,10 @@ Writes the <saml:Conditions> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2669,10 +2669,10 @@ Writes the <saml:Evidence> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2701,10 +2701,10 @@ Writes the <saml:Issuer> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2733,10 +2733,10 @@ Serializes a to the specified XML writer. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2765,10 +2765,10 @@ Writes the <saml:NameID> element. To be added. - is . - - -or- - + is . + + -or- + is . The Saml2NameIdentifier encrypting credentials must have a Symmetric Key specified. @@ -2798,10 +2798,10 @@ Both <Issuer> and <NameID> are of NameIDType. This method writes the content of either one of those elements. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2830,10 +2830,10 @@ Writes the <saml:ProxyRestriction> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2862,10 +2862,10 @@ Writes the Signing <ds:KeyInfo> element using the specified XML writer. To be added. - is . - - -or- - + is . + + -or- + is . The handler cannot serialize the key identifier specified by . @@ -2894,18 +2894,18 @@ The data to write. Writes a Saml2Statement. - , \, or \ element. To handle custom classes for writing a \ element, override this method. - + , \, or \ element. To handle custom classes for writing a \ element, override this method. + ]]> - is . - - -or- - + is . + + -or- + is . @@ -2934,10 +2934,10 @@ Writes the <saml:Subject> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2966,10 +2966,10 @@ Writes the <saml:SubjectConfirmation> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2997,18 +2997,18 @@ The data to write. Writes the <saml:SubjectConfirmationData> element. - - is . - - -or- - + is . + + -or- + is . @@ -3037,10 +3037,10 @@ Serializes the Subject <ds:KeyInfo> element using the specified XML writer. To be added. - is . - - -or- - + is . + + -or- + is . @@ -3069,10 +3069,10 @@ Writes the <saml:SubjectLocality> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -3101,10 +3101,10 @@ Writes a Saml2 Token to the specified XML writer. To be added. - is . - - -or- - + is . + + -or- + is . is not a object. diff --git a/xml/System.IdentityModel.Tokens/SamlSecurityTokenHandler.xml b/xml/System.IdentityModel.Tokens/SamlSecurityTokenHandler.xml index 91e24d8df47..45ab1109834 100644 --- a/xml/System.IdentityModel.Tokens/SamlSecurityTokenHandler.xml +++ b/xml/System.IdentityModel.Tokens/SamlSecurityTokenHandler.xml @@ -16,15 +16,15 @@ Represents a security token handler that creates security tokens from SAML 1.1 Assertions. - class serializes and deserializes security tokens backed by SAML 1.1 Assertions into objects. Security token handlers are responsible for creating, reading, writing, and validating tokens. - - You can configure a security token service (STS) or relying party (RP) application to process SAML 1.1 Assertion-backed security tokens by adding an instance of the class to the object configured for the service (or application). This can be done either programmatically or in the configuration file. The handler itself is configured from the configuration specified for the collection through the collection's property when it is added to the collection. While it is possible to configure the handler individually by setting its property, this is not normally necessary; however, if the handler must be configured individually, the property should be set after the handler is added to the collection. - - For many scenarios, the class can be used as-is; however, the class provides many extension points through the methods it exposes. By deriving from the and overriding specific methods, you can modify the functionality of the token processing provided in the default implementation, or you can add processing for extensions to the SAML Assertion specification that may be needed in some custom scenarios. - + class serializes and deserializes security tokens backed by SAML 1.1 Assertions into objects. Security token handlers are responsible for creating, reading, writing, and validating tokens. + + You can configure a security token service (STS) or relying party (RP) application to process SAML 1.1 Assertion-backed security tokens by adding an instance of the class to the object configured for the service (or application). This can be done either programmatically or in the configuration file. The handler itself is configured from the configuration specified for the collection through the collection's property when it is added to the collection. While it is possible to configure the handler individually by setting its property, this is not normally necessary; however, if the handler must be configured individually, the property should be set after the handler is added to the collection. + + For many scenarios, the class can be used as-is; however, the class provides many extension points through the methods it exposes. By deriving from the and overriding specific methods, you can modify the functionality of the token processing provided in the default implementation, or you can add processing for extensions to the SAML Assertion specification that may be needed in some custom scenarios. + ]]> @@ -55,11 +55,11 @@ Initializes a new instance of the class with default security token requirements. - property is set to an instance of that is created with the parameterless constructor. - + property is set to an instance of that is created with the parameterless constructor. + ]]> @@ -115,10 +115,10 @@ Adds all of the delegates associated with the ActAs subject into the attribute collection. To be added. - is . - - -or- - + is . + + -or- + is . @@ -208,11 +208,11 @@ , which indicates that the handler can validate tokens of type . - @@ -235,13 +235,13 @@ Gets a value that indicates whether this handler can serialize tokens of type . - ; which indicates that the handler can serialize tokens of type . + , which indicates that the handler can serialize tokens of type . - @@ -315,11 +315,11 @@ When overridden in a derived class, creates a object for the assertion. A object. The default is . - @@ -353,11 +353,11 @@ Creates a object by using the specified issuer, conditions, advice and statements. You can override this method to customize the parameters used to create the assertion. The SAML assertion that was created. - property is set to this value. The is set to . - + property is set to this value. The is set to . + ]]> @@ -418,11 +418,11 @@ Creates a object from a token descriptor. A that contains the converted claims. - @@ -455,10 +455,10 @@ The SAML authentication statement that was created. To be added. - is . - - -or- - + is . + + -or- + is . @@ -519,13 +519,13 @@ Creates the conditions for the assertion. A object that contains the conditions for the assertion. - property of the `tokenDescriptor`. It will also generate an AudienceRestrictionCondition limiting consumption of the assertion to the property of the `tokenDescriptor`. - + property of the `tokenDescriptor`. It will also generate an AudienceRestrictionCondition limiting consumption of the assertion to the property of the `tokenDescriptor`. + ]]> @@ -609,11 +609,11 @@ Creates SAML 1.1 statements to be included in the assertion. An enumeration of that contains the statements. - @@ -697,11 +697,11 @@ Builds an XML formatted string from a collection of SAML 1.1 attributes that represent the Actor. A well-formed XML string constructed using the attributes. - \\...\, ...\...\" - + \\...\, ...\...\" + ]]> @@ -729,11 +729,11 @@ Returns the SAML11 authentication method identifier that matches the specified normalized value for a SAML authentication method. The SAML11 authentication method identifier (URI) that matches the specified normalized identifier. If no matching SAML11 authentication method is found, the URI is returned unaltered. - method returns the SAML11 authentication method identifier that matches the specified normalized URI. For example, if is specified for `normalizedAuthenticationType`, the following URI is returned: `urn:oasis:names:tc:SAML:1.0:am:X509-PKI`. If a mapping does not exist for `normalizedAuthenticationType`, it is returned unaltered. - + method returns the SAML11 authentication method identifier that matches the specified normalized URI. For example, if is specified for `normalizedAuthenticationType`, the following URI is returned: `urn:oasis:names:tc:SAML:1.0:am:X509-PKI`. If a mapping does not exist for `normalizedAuthenticationType`, it is returned unaltered. + ]]> @@ -760,19 +760,19 @@ A that represents the SAML 1.1 security token (the token should be of type ) to be checked. Throws an exception if the specified token already exists in the token replay cache; otherwise the token is added to the cache. - object configured for this handler through the property of the object referenced through the property. - + object configured for this handler through the property of the object referenced through the property. + ]]> is . - The property is . - - -or- - + The property is . + + -or- + The property of the handler configuration (accessed through the property) is . cannot be cast as an instance of . @@ -828,11 +828,11 @@ Gets the token encrypting credentials. Override this method to change the token encrypting credentials. An that represents the token encrypting credentials. - property of the `tokenDescriptor`. - + property of the `tokenDescriptor`. + ]]> @@ -863,13 +863,13 @@ Gets the credentials for signing the assertion. A that represents the credentials for signing the assertion. - property of the `tokenDescriptor` to retrieve the credentials. - + property of the `tokenDescriptor` to retrieve the credentials. + ]]> @@ -899,15 +899,15 @@ Returns the time until which the token should be held in the token replay cache. A that represents the expiration time. - ) than Configuration.TokenReplayCacheExpirationPeriod. - + ) than Configuration.TokenReplayCacheExpirationPeriod. + ]]> @@ -955,11 +955,11 @@ Gets or sets the security token serializer that is used to serialize and deserialize key identifiers. A that represents the serializer. - objects. - + objects. + ]]> An attempt to set the value to occurs. @@ -1035,11 +1035,11 @@ Returns the normalized value that matches a SAML 1.1 authentication method identifier. The normalized value, which is one of the values. If no matching value exists, is returned, unaltered. - method returns the value that matches the specified SAML11 authentication method identifier. For example, if `urn:oasis:names:tc:SAML:1.0:am:X509-PKI` is specified for `saml11AuthenticationMethod`, is returned. If a mapping does not exist for `saml11AuthenticationMethod`, it is returned unaltered. - + method returns the value that matches the specified SAML11 authentication method identifier. For example, if `urn:oasis:names:tc:SAML:1.0:am:X509-PKI` is specified for `saml11AuthenticationMethod`, is returned. If a mapping does not exist for `saml11AuthenticationMethod`, it is returned unaltered. + ]]> @@ -1070,18 +1070,18 @@ The issuer. Creates claims from a SAML 1.1 attribute statement and adds them to the specified subject. - - is . - - -or- - + is . + + -or- + is . @@ -1112,10 +1112,10 @@ Creates claims from a SAML 1.1 authentication statement and adds them to the specified subject. To be added. - is . - - -or- - + is . + + -or- + is . @@ -1145,11 +1145,11 @@ The issuer. Creates claims from a SAML 1.1 authorization decision statement and adds them to the specified subject. - @@ -1264,11 +1264,11 @@ Reads the <saml:Advice> element. A that represents the Advice element that is read. - @@ -1325,11 +1325,11 @@ Reads the <saml:Attribute> element. A that represents the Assertion element that is read. - @@ -1554,11 +1554,11 @@ Reads the <saml:Conditions> element. A that represents the Conditions element that is read. - elements, override this method. - + elements, override this method. + ]]> @@ -1675,11 +1675,11 @@ Reads the <saml:Statement> element. A that represents the Statement element that was read. - @@ -1709,11 +1709,11 @@ Reads the <saml:Subject> element. A that represents the Subject element that was read. - element. To handle encrypted IDs in the Subject, override this method. - + element. To handle encrypted IDs in the Subject, override this method. + ]]> @@ -1770,14 +1770,14 @@ Reads a SAML 1.1 token from the specified stream. An instance of . To be added. - The property is . - - -or- - - The property of the configuration specified by the property is . - - -or- - + The property is . + + -or- + + The property of the configuration specified by the property is . + + -or- + The property of the configuration specified by the property is . @@ -1984,11 +1984,11 @@ to check for Audience Restriction condition. Validates the specified object. - @@ -2016,11 +2016,11 @@ Validates the token data and returns its claims. The identities contained in the token. - @@ -2050,10 +2050,10 @@ Writes the <saml:Action> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2082,10 +2082,10 @@ Writes the <saml:Advice> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2114,10 +2114,10 @@ Serializes the specified SAML assertion to the specified XML writer. To be added. - is . - - -or- - + is . + + -or- + is . The token encrypting credentials do not have a Symmetric Key specified. @@ -2147,10 +2147,10 @@ Writes the <saml:Attribute> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2179,10 +2179,10 @@ Writes the <saml:AttributeStatement> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2212,11 +2212,11 @@ A that represents the attribute whose value is being written. Writes the saml:Attribute value. - @@ -2248,10 +2248,10 @@ Writes the <saml:AudienceRestriction> element. To be added. - is . - - -or- - + is . + + -or- + is . The property of the specified in is or an empty collection. @@ -2281,10 +2281,10 @@ Writes the <saml:AuthnStatement> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2313,10 +2313,10 @@ Writes the <saml:AuthorityBinding> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2345,10 +2345,10 @@ Writes the <saml:AuthzDecisionStatement> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2376,18 +2376,18 @@ The data to write. By default, only and are supported. Serializes the specified object. - or method to serialize the condition based on the type of specified. - + or method to serialize the condition based on the type of specified. + ]]> - is . - - -or- - + is . + + -or- + is . is not supported. . By default, only and are supported. @@ -2418,10 +2418,10 @@ Writes the <saml:Conditions> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2450,10 +2450,10 @@ Writes the <saml:DoNotCacheCondition> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2482,10 +2482,10 @@ Writes the <saml:Evidence> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2514,10 +2514,10 @@ Writes the Signing <ds:KeyInfo> element using the specified XML writer. To be added. - is . - - -or- - + is . + + -or- + is . The handler cannot serialize the key identifier specified by . @@ -2546,18 +2546,18 @@ The data to write. Writes a SamlStatement. - , \, or \ element. To handle custom classes for writing a \ element, override this method. - + , \, or \ element. To handle custom classes for writing a \ element, override this method. + ]]> - is . - - -or- - + is . + + -or- + is . @@ -2586,10 +2586,10 @@ Writes the <saml:Subject> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2618,10 +2618,10 @@ Serializes the Subject <ds:KeyInfo> element using the specified XML writer. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2650,10 +2650,10 @@ Writes a Saml Token to the specified XML writer. To be added. - is . - - -or- - + is . + + -or- + is . is not a object. diff --git a/xml/System.IdentityModel.Tokens/SecurityKeyType.xml b/xml/System.IdentityModel.Tokens/SecurityKeyType.xml index 450b60226d2..3d270835194 100644 --- a/xml/System.IdentityModel.Tokens/SecurityKeyType.xml +++ b/xml/System.IdentityModel.Tokens/SecurityKeyType.xml @@ -40,24 +40,24 @@ Specifies the type of key that is associated with a security token. - enumeration to set the property. - - The `BearerKey` field is used with the property. - -### BearerKey Requires Wsu:Id or Transport Security with Message Credentials - In federation scenarios, an issued token is generally configured as an endorsing supporting token for message security between a client and the relying parties. However, when a Security Token Service (STS) issues a token with no key (BearerKey), WCF configures it as a supporting token (WCF cannot endorse without a key). This requires the issued token to be referenced in the signature. WCF currently uses the following: `http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd:Id` as a reference mechanism (Wsu:Id). - - If an issued token does not have such an attribute, on a client, a is thrown with the text "Element to sign must have id". This happens when a SAML 1.1 token is used as an issued token (the Wsu:Id is not defined in the SAML 1.1 specification). - - To work around this situation, either use transport security with message credentials (for example, ), or an STS must add the `http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd:Id` (Wsu:Id) to the issued token. - - Note that if the Wsu:Id is added to a SAML 1.1 token, the resulting XML does not comply to the SAML 1.1 specification. The alternative is to add a Wsu:Id to the `EncryptedData` which is a result of encrypting the issued token. This procedure complies with the SAML 1.1 specification, because the `EncryptedData` element supports the Wsu:Id attribute. - - So to be compliant with the specification, the bearer token must be encrypted by the STS. - + enumeration to set the property. + + The `BearerKey` field is used with the property. + +### BearerKey Requires Wsu:Id or Transport Security with Message Credentials + In federation scenarios, an issued token is generally configured as an endorsing supporting token for message security between a client and the relying parties. However, when a Security Token Service (STS) issues a token with no key (BearerKey), WCF configures it as a supporting token (WCF cannot endorse without a key). This requires the issued token to be referenced in the signature. WCF currently uses the following: `http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd:Id` as a reference mechanism (Wsu:Id). + + If an issued token does not have such an attribute, on a client, a is thrown with the text "Element to sign must have id". This happens when a SAML 1.1 token is used as an issued token (the Wsu:Id is not defined in the SAML 1.1 specification). + + To work around this situation, either use transport security with message credentials (for example, ), or an STS must add the `http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd:Id` (Wsu:Id) to the issued token. + + Note that if the Wsu:Id is added to a SAML 1.1 token, the resulting XML does not comply to the SAML 1.1 specification. The alternative is to add a Wsu:Id to the `EncryptedData` that is a result of encrypting the issued token. This procedure complies with the SAML 1.1 specification, because the `EncryptedData` element supports the Wsu:Id attribute. + + So to be compliant with the specification, the bearer token must be encrypted by the STS. + ]]> diff --git a/xml/System.IdentityModel.Tokens/SecurityTokenElement.xml b/xml/System.IdentityModel.Tokens/SecurityTokenElement.xml index 45fc88992ba..04ce38fd8eb 100644 --- a/xml/System.IdentityModel.Tokens/SecurityTokenElement.xml +++ b/xml/System.IdentityModel.Tokens/SecurityTokenElement.xml @@ -14,13 +14,13 @@ - Represents a number elements found in a which represent security tokens. + Represents a number elements found in a , which represent security tokens. - @@ -53,13 +53,13 @@ The security token that the new instance represents. Initializes a new instance of the class by using a object. - method is not supported by the new instance unless the method is overridden. - - If the `securityToken` parameter is an instance of then the property is set to the value of the property. - + method is not supported by the new instance unless the method is overridden. + + If the `securityToken` parameter is an instance of then the property is set to the value of the property. + ]]> @@ -129,11 +129,11 @@ Gets the security token that is represented by the current instance. The security token that the current instance represents. - object by using the constructor, then the method is called to return the security token. - + object by using the constructor, then the method is called to return the security token. + ]]> @@ -184,11 +184,11 @@ Gets the XML representation of the wrapped token. The XML representation of the token. - constructor. - + constructor. + ]]> @@ -219,10 +219,10 @@ The identities that are contained in the token. To be added. - is . - - -or- - + is . + + -or- + is . diff --git a/xml/System.IdentityModel.Tokens/SessionSecurityTokenCacheKey.xml b/xml/System.IdentityModel.Tokens/SessionSecurityTokenCacheKey.xml index e5bcf856dd4..382548beb11 100644 --- a/xml/System.IdentityModel.Tokens/SessionSecurityTokenCacheKey.xml +++ b/xml/System.IdentityModel.Tokens/SessionSecurityTokenCacheKey.xml @@ -16,13 +16,13 @@ Represents the key for an entry in a . - there are two indexes required. One is the context ID, represented by the property, that is unique across all session tokens. The other is the key generation, represented by the property, which is unique within a session token. When a session token is issued it has only a context ID. When the session token is renewed, the key generation is added. After renewal, the renewed session token is uniquely identifiable via the context ID and key generation. - - Objects of type are used as the indexes to the session token cache. An index will always have a valid property specified, but the property may be `null`, depending on whether the token has been renewed. There is also an optional which gives the endpoint to which the token is scoped. - + there are two indexes required. One is the context ID, represented by the property, that is unique across all session tokens. The other is the key generation, represented by the property, which is unique within a session token. When a session token is issued it has only a context ID. When the session token is renewed, the key generation is added. After renewal, the renewed session token is uniquely identifiable via the context ID and key generation. + + Objects of type are used as the indexes to the session token cache. An index will always have a valid property specified, but the property may be `null`, depending on whether the token has been renewed. There is also an optional that gives the endpoint to which the token is scoped. + ]]> @@ -71,11 +71,11 @@ Gets the context ID for the cache key. The context ID for the cache key. - property of the cached token. - + property of the cached token. + ]]> @@ -99,11 +99,11 @@ Gets the Endpoint ID to which this cache entry is scoped. The Endpoint ID to which this cache entry is scoped. - property of the cached token. - + property of the cached token. + ]]> @@ -132,11 +132,11 @@ if the specified object is the same as the current cache key; otherwise, . - is `true`, the property is not used in the comparison. - + is `true`, the property is not used in the comparison. + ]]> @@ -161,11 +161,11 @@ Returns a hash code for the current cache key. The hash code for the current cache key. - is `true`, the property is not used in generating the hash code. - + is `true`, the property is not used in generating the hash code. + ]]> @@ -190,11 +190,11 @@ to ignore key generation; otherwise, . - property is treated by the following methods and operators: , , , , and . - + property is treated by the following methods and operators: , , , , and . + ]]> @@ -218,11 +218,11 @@ Gets the key generation for the cache key. The key generation for the cache key. - property of the cached token. - + property of the cached token. + ]]> @@ -253,11 +253,11 @@ if the cache keys are equal; otherwise, . - is `true`, the property is not used in the comparison. - + is `true`, the property is not used in the comparison. + ]]> @@ -288,11 +288,11 @@ if the cache keys are not equal; otherwise, . - is `true`, the property is not used in the comparison. - + is `true`, the property is not used in the comparison. + ]]> @@ -317,11 +317,11 @@ Overrides to provide a unique identifier. The key in string form. - is `true`, the property is not used. - + is `true`, the property is not used. + ]]> diff --git a/xml/System.Management.Instrumentation/ManagedCommonProvider.xml b/xml/System.Management.Instrumentation/ManagedCommonProvider.xml index 6b661ce2c96..8395f305292 100644 --- a/xml/System.Management.Instrumentation/ManagedCommonProvider.xml +++ b/xml/System.Management.Instrumentation/ManagedCommonProvider.xml @@ -57,7 +57,7 @@ - This is the parameterless constructor for which is used internally by the WMI.NET Provider Extensions infrastructure. + This is the parameterless constructor for that's used internally by the WMI.NET Provider Extensions infrastructure. To be added. diff --git a/xml/System.Management.Instrumentation/ManagementMemberAttribute.xml b/xml/System.Management.Instrumentation/ManagementMemberAttribute.xml index 853fff1d112..13302c673bd 100644 --- a/xml/System.Management.Instrumentation/ManagementMemberAttribute.xml +++ b/xml/System.Management.Instrumentation/ManagementMemberAttribute.xml @@ -86,7 +86,7 @@ Gets or sets the name of the management attribute. - Returns a string which is the name of the management attribute. + The name of the management attribute. To be added. diff --git a/xml/System.Management/ManagementClass.xml b/xml/System.Management/ManagementClass.xml index b88bb4cae84..1b9e198df68 100644 --- a/xml/System.Management/ManagementClass.xml +++ b/xml/System.Management/ManagementClass.xml @@ -40,13 +40,13 @@ Initializes a new instance of the class. - @@ -69,21 +69,21 @@ Initializes a new instance of the class. This is the parameterless constructor. - variable with the parameterless constructor. The example lists the methods, properties, and qualifiers for the created class. - + variable with the parameterless constructor. The example lists the methods, properties, and qualifiers for the created class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass/cs/ManagementClass.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass/vb/ManagementClass.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass/vb/ManagementClass.vb" id="Snippet1"::: + ]]> @@ -110,22 +110,22 @@ A specifying the WMI class to which to bind. The parameter must specify a WMI class path. The class represents a CIM management class from WMI. CIM classes represent management information including hardware, software, processes, and so on. For more information about the CIM classes available in Windows, see CIM Classes. Initializes a new instance of the class. The class represents a Common Information Model (CIM) management class from WMI such as **Win32_LogicalDisk**, which can represent a disk drive, and **Win32_Process**, which represents a process such as Notepad.exe. - variable with a constructor. The example lists the methods, properties, and qualifiers for the created class. - + variable with a constructor. The example lists the methods, properties, and qualifiers for the created class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass-M/cs/ManagementClass-M.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass-M/vb/ManagementClass-M.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass-M/vb/ManagementClass-M.vb" id="Snippet1"::: + ]]> @@ -152,21 +152,21 @@ The path to the WMI class. The class represents a CIM management class from WMI. CIM classes represent management information including hardware, software, processes, and so on. For more information about the CIM classes available in Windows, see CIM Classes. Initializes a new instance of the class initialized to the given path. The class represents a Common Information Model (CIM) management class from WMI such as **Win32_LogicalDisk**, which can represent a disk drive, and **Win32_Process**, which represents a process such as Notepad.exe. - variable with a constructor. The example lists the methods, properties, and qualifiers for the created class. - + variable with a constructor. The example lists the methods, properties, and qualifiers for the created class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass-S/cs/ManagementClass-S.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass-S/vb/ManagementClass-S.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass-S/vb/ManagementClass-S.vb" id="Snippet1"::: + ]]> @@ -195,21 +195,21 @@ An representing the options to use when retrieving this class. Initializes a new instance of the class initialized to the given WMI class path using the specified options. The class represents a Common Information Model (CIM) management class from WMI such as **Win32_LogicalDisk**, which can represent a disk drive, and **Win32_Process**, which represents a process such as Notepad.exe. - variable with a constructor. The example lists the methods, properties, and qualifiers (including the amended qualifiers) for the created class. - + variable with a constructor. The example lists the methods, properties, and qualifiers (including the amended qualifiers) for the created class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass-M_O/cs/ManagementClass-M_O.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass-M_O/vb/ManagementClass-M_O.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass-M_O/vb/ManagementClass-M_O.vb" id="Snippet1"::: + ]]> @@ -247,13 +247,13 @@ An instance of the class containing the source of the serialized stream associated with the new . Initializes a new instance of the class from the specified instances of the and classes. - @@ -282,21 +282,21 @@ An representing the options to use when retrieving the WMI class. Initializes a new instance of the class initialized to the given WMI class path using the specified options. The class represents a Common Information Model (CIM) management class from WMI such as **Win32_LogicalDisk**, which can represent a disk drive, and **Win32_Process**, which represents a process such as Notepad.exe. - variable with a constructor. The example lists the methods, properties, and qualifiers (including the amended qualifiers) for the created class. - + variable with a constructor. The example lists the methods, properties, and qualifiers (including the amended qualifiers) for the created class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass-S_O/cs/ManagementClass-S_O.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass-S_O/vb/ManagementClass-S_O.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass-S_O/vb/ManagementClass-S_O.vb" id="Snippet1"::: + ]]> @@ -327,22 +327,22 @@ An that specifies the options to use when retrieving the WMI class. Initializes a new instance of the class for the specified WMI class in the specified scope and with the specified options. The class represents a Common Information Model (CIM) management class from WMI such as **Win32_LogicalDisk**, which can represent a disk drive, and **Win32_Process**, which represents a process such as Notepad.exe. - variable with a constructor. The example lists the methods, properties, and qualifiers (including the amended qualifiers) for the created class. You must change the scope (namespace) in the code for the example to run correctly on your computer. - + variable with a constructor. The example lists the methods, properties, and qualifiers (including the amended qualifiers) for the created class. You must change the scope (namespace) in the code for the example to run correctly on your computer. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass-M_M_O/cs/ManagementClass-M_M_O.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass-M_M_O/vb/ManagementClass-M_M_O.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass-M_M_O/vb/ManagementClass-M_M_O.vb" id="Snippet1"::: + ]]> @@ -373,22 +373,22 @@ An that specifies the options to use when retrieving the WMI class. Initializes a new instance of the class for the specified WMI class, in the specified scope, and with the specified options. The class represents a Common Information Model (CIM) management class from WMI such as **Win32_LogicalDisk**, which can represent a disk drive, and **Win32_Process**, which represents a process such as Notepad.exe. - variable with a constructor. The example lists the methods, properties, and qualifiers (including the amended qualifiers) for the created class. You must change the scope (namespace) in the code for the example to run correctly on your computer. - + variable with a constructor. The example lists the methods, properties, and qualifiers (including the amended qualifiers) for the created class. You must change the scope (namespace) in the code for the example to run correctly on your computer. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass-S_S_O/cs/ManagementClass-S_S_O.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass-S_S_O/vb/ManagementClass-S_S_O.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass-S_S_O/vb/ManagementClass-S_S_O.vb" id="Snippet1"::: + ]]> @@ -416,14 +416,14 @@ Returns a copy of the object. The cloned object. - @@ -451,22 +451,22 @@ Initializes a new instance of the WMI class. A that represents a new instance of the WMI class. - () method is called. Before committing it, the key properties must be specified. - -## .NET Framework Security - Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see [Using Libraries from Partially Trusted Code](/dotnet/framework/misc/using-libraries-from-partially-trusted-code). - - - -## Examples - The following example shows how to initialize a variable with a constructor and then create a new instance of a WMI class. - + () method is called. Before committing it, the key properties must be specified. + +## .NET Framework Security + Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see [Using Libraries from Partially Trusted Code](/dotnet/framework/misc/using-libraries-from-partially-trusted-code). + + + +## Examples + The following example shows how to initialize a variable with a constructor and then create a new instance of a WMI class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass_CreateInstance/cs/ManagementClass_CreateInstance.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_CreateInstance/vb/ManagementClass_CreateInstance.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_CreateInstance/vb/ManagementClass_CreateInstance.vb" id="Snippet1"::: + ]]> @@ -493,22 +493,22 @@ Gets an array containing all WMI classes in the inheritance hierarchy from this class to the top of the hierarchy. A string collection containing the names of all WMI classes in the inheritance hierarchy of this class. - variable with a constructor and then get all the classes in the inheritance hierarchy from the WMI class passed into the constructor, to the top of the hierarchy. - + variable with a constructor and then get all the classes in the inheritance hierarchy from the WMI class passed into the constructor, to the top of the hierarchy. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass_Derivation/cs/ManagementClass_Derivation.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_Derivation/vb/ManagementClass_Derivation.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_Derivation/vb/ManagementClass_Derivation.vb" id="Snippet1"::: + ]]> @@ -539,22 +539,22 @@ Derives a new class from this class. A new that represents a new WMI class derived from the original class. - () method is explicitly called. - -## .NET Framework Security - Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see [Using Libraries from Partially Trusted Code](/dotnet/framework/misc/using-libraries-from-partially-trusted-code). - - - -## Examples - The following example shows how to initialize a variable with a constructor and then create a derived instance of a WMI class. - + () method is explicitly called. + +## .NET Framework Security + Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see [Using Libraries from Partially Trusted Code](/dotnet/framework/misc/using-libraries-from-partially-trusted-code). + + + +## Examples + The following example shows how to initialize a variable with a constructor and then create a derived instance of a WMI class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass_Derive/cs/ManagementClass_Derive.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_Derive/vb/ManagementClass_Derive.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_Derive/vb/ManagementClass_Derive.vb" id="Snippet1"::: + ]]> @@ -567,13 +567,13 @@ Returns the collection of all instances of the class. - @@ -601,21 +601,21 @@ Returns the collection of all instances of the class. A collection of the objects representing the instances of the class. - variable with a constructor and then get all the instances of a WMI class. - + variable with a constructor and then get all the instances of a WMI class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass_GetInstances/cs/ManagementClass_GetInstances.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_GetInstances/vb/ManagementClass_GetInstances.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_GetInstances/vb/ManagementClass_GetInstances.vb" id="Snippet1"::: + ]]> @@ -646,21 +646,21 @@ Returns the collection of all instances of the class using the specified options. A collection of the objects representing the instances of the class, according to the specified options. - variable with a constructor and then get all the instances of a WMI class and its subclasses. - + variable with a constructor and then get all the instances of a WMI class and its subclasses. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass_GetInstances-E/cs/ManagementClass_GetInstances-E.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_GetInstances-E/vb/ManagementClass_GetInstances-E.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_GetInstances-E/vb/ManagementClass_GetInstances-E.vb" id="Snippet1"::: + ]]> @@ -690,21 +690,21 @@ The object to handle the asynchronous operation's progress. Returns the collection of all instances of the class, asynchronously. - variable with a constructor and then get all the instances of a WMI class asynchronously. - + variable with a constructor and then get all the instances of a WMI class asynchronously. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass_GetInstances-M/cs/ManagementClass_GetInstances-M.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_GetInstances-M/vb/ManagementClass_GetInstances-M.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_GetInstances-M/vb/ManagementClass_GetInstances-M.vb" id="Snippet1"::: + ]]> @@ -736,13 +736,13 @@ The specified additional options for getting the instances. Returns the collection of all instances of the class, asynchronously, using the specified options. - @@ -773,13 +773,13 @@ The location where serialized data will be stored and retrieved. Populates a with the data necessary to deserialize the field represented by this instance. - @@ -792,13 +792,13 @@ Retrieves classes related to the WMI class. - @@ -826,22 +826,22 @@ Retrieves classes related to the WMI class. A collection of the or objects that represents WMI classes or instances related to the WMI class. - variable with a constructor and then list all the classes related to the WMI class passed into the constructor. - + variable with a constructor and then list all the classes related to the WMI class passed into the constructor. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass_GetRelatedClasses/cs/ManagementClass_GetRelatedClasses.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_GetRelatedClasses/vb/ManagementClass_GetRelatedClasses.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_GetRelatedClasses/vb/ManagementClass_GetRelatedClasses.vb" id="Snippet1"::: + ]]> @@ -871,13 +871,13 @@ The object to handle the asynchronous operation's progress. Retrieves classes related to the WMI class, asynchronously. - @@ -908,13 +908,13 @@ Retrieves classes related to the WMI class. A collection of classes related to this class. - @@ -946,13 +946,13 @@ The name of the related class. Retrieves classes related to the WMI class, asynchronously, given the related class name. - @@ -986,7 +986,7 @@ The class from which resulting classes have to be derived. - The relationship type which resulting classes must have with the source class. + The relationship type that resulting classes must have with the source class. This qualifier must be present on the relationship. This qualifier must be present on the resulting classes. The resulting classes must have this role in the relationship. @@ -995,21 +995,21 @@ Retrieves classes related to the WMI class based on the specified options. A collection of classes related to this class. - method to list the related classes to the **CIM_LogicalDisk** class. For more information, see [CIM_LogicalDisk](/windows/win32/cimwin32prov/cim-logicaldisk). - + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass_GetRelatedClasses-7/cs/ManagementClass_GetRelatedClasses-7.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_GetRelatedClasses-7/vb/ManagementClass_GetRelatedClasses-7.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_GetRelatedClasses-7/vb/ManagementClass_GetRelatedClasses-7.vb" id="Snippet1"::: + ]]> @@ -1045,7 +1045,7 @@ Handler for progress and results of the asynchronous operation. The class from which resulting classes have to be derived. - The relationship type which resulting classes must have with the source class. + The relationship type that resulting classes must have with the source class. This qualifier must be present on the relationship. This qualifier must be present on the resulting classes. The resulting classes must have this role in the relationship. @@ -1053,13 +1053,13 @@ The options for retrieving the resulting classes. Retrieves classes related to the WMI class, asynchronously, using the specified options. - @@ -1072,13 +1072,13 @@ Retrieves relationship classes that relate the class to others. - @@ -1106,21 +1106,21 @@ Retrieves relationship classes that relate the class to others. A collection of *association classes* that relate the class to any other class. - method to list the relationship classes to the **CIM_LogicalDisk** class. For more information, see [CIM_LogicalDisk](/windows/win32/cimwin32prov/cim-logicaldisk). - + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass_GetRelationshipClasses/cs/ManagementClass_GetRelationshipClasses.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_GetRelationshipClasses/vb/ManagementClass_GetRelationshipClasses.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_GetRelationshipClasses/vb/ManagementClass_GetRelationshipClasses.vb" id="Snippet1"::: + ]]> @@ -1150,13 +1150,13 @@ The object to handle the asynchronous operation's progress. Retrieves relationship classes that relate the class to others, asynchronously. - @@ -1187,13 +1187,13 @@ Retrieves relationship classes that relate the class to others, where the endpoint class is the specified class. A collection of *association classes* that relate the class to the specified class. For more information about relationship classes, ASSOCIATORS OF Statement. - @@ -1225,14 +1225,14 @@ The WMI class to which all returned relationships should point. Retrieves relationship classes that relate the class to the specified WMI class, asynchronously. - @@ -1269,13 +1269,13 @@ Retrieves relationship classes that relate this class to others, according to specified options. A collection of *association classes* that relate this class to others, according to the specified options. For more information about relationship classes, ASSOCIATORS OF Statement. - @@ -1309,17 +1309,17 @@ The handler for progress and results of the asynchronous operation. The class from which all resulting relationship classes must derive. The qualifier which the resulting relationship classes must have. - The role which the source class must have in the resulting relationship classes. + The role that the source class must have in the resulting relationship classes. The options for retrieving the results. Retrieves relationship classes that relate the class according to the specified options, asynchronously. - @@ -1332,13 +1332,13 @@ Generates a strongly-typed class for a given WMI class. - @@ -1373,21 +1373,21 @@ Generates a strongly-typed class for a given WMI class. A representing the declaration for the strongly-typed class. - @@ -1423,21 +1423,21 @@ , if the method succeeded; otherwise, . - @@ -1450,13 +1450,13 @@ Returns the collection of all derived classes for the class. - @@ -1484,21 +1484,21 @@ Returns the collection of all subclasses for the class. A collection of the objects that represent the subclasses of the WMI class. - method to list the subclasses to the **CIM_LogicalDisk** class. For more information, see [CIM_LogicalDisk](/windows/win32/cimwin32prov/cim-logicaldisk). - + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass_GetSubClasses/cs/ManagementClass_GetSubclasses.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_GetSubClasses/vb/ManagementClass_GetSubclasses.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_GetSubClasses/vb/ManagementClass_GetSubclasses.vb" id="Snippet1"::: + ]]> @@ -1529,21 +1529,21 @@ Retrieves the subclasses of the class using the specified options. A collection of the objects representing the subclasses of the WMI class, according to the specified options. - variable with a constructor and then receive the subclasses of the WMI class passed into the constructor. - + variable with a constructor and then receive the subclasses of the WMI class passed into the constructor. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass_GetSubClasses-E/cs/ManagementClass_GetSubclasses-E.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_GetSubClasses-E/vb/ManagementClass_GetSubclasses-E.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_GetSubClasses-E/vb/ManagementClass_GetSubclasses-E.vb" id="Snippet1"::: + ]]> @@ -1573,13 +1573,13 @@ The object to handle the asynchronous operation's progress. Returns the collection of all classes derived from this class, asynchronously. - @@ -1611,13 +1611,13 @@ The specified additional options to use in the derived class retrieval. Retrieves all classes derived from this class, asynchronously, using the specified options. - @@ -1644,21 +1644,21 @@ Gets or sets a collection of objects that represent the methods defined in the WMI class. A representing the methods defined in the WMI class. - variable with a constructor and then get all the methods in the WMI class passed into the constructor. - + variable with a constructor and then get all the methods in the WMI class passed into the constructor. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass_Methods/cs/ManagementClass_Methods.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_Methods/vb/ManagementClass_Methods.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_Methods/vb/ManagementClass_Methods.vb" id="Snippet1"::: + ]]> @@ -1685,22 +1685,22 @@ Gets or sets the path of the WMI class to which the object is bound. The path of the object's class. - will be disconnected from any previously-bound WMI class. Reconnect to the new WMI class path. - -## .NET Framework Security - Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see [Using Libraries from Partially Trusted Code](/dotnet/framework/misc/using-libraries-from-partially-trusted-code). - - - -## Examples - The following example shows how to initialize a variable with a constructor and then get all the methods in the WMI class passed into the constructor. - + will be disconnected from any previously-bound WMI class. Reconnect to the new WMI class path. + +## .NET Framework Security + Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see [Using Libraries from Partially Trusted Code](/dotnet/framework/misc/using-libraries-from-partially-trusted-code). + + + +## Examples + The following example shows how to initialize a variable with a constructor and then get all the methods in the WMI class passed into the constructor. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_ManagementClass_Path/cs/ManagementClass_Path.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_Path/vb/ManagementClass_Path.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_ManagementClass_Path/vb/ManagementClass_Path.vb" id="Snippet1"::: + ]]> diff --git a/xml/System.Management/WqlEventQuery.xml b/xml/System.Management/WqlEventQuery.xml index 0828c322493..7c8d2bc9c08 100644 --- a/xml/System.Management/WqlEventQuery.xml +++ b/xml/System.Management/WqlEventQuery.xml @@ -52,13 +52,13 @@ Initializes a new instance of the class. This is the parameterless constructor. - @@ -85,21 +85,21 @@ The string representing either the entire event query or the name of the event class to query. The object will try to parse the string as a valid event query. If unsuccessful, the parser will assume that the parameter represents an event class name. Initializes a new instance of the class based on the given query string or event class name. - by specifying a query and then initializes a by specifying an event. - + by specifying a query and then initializes a by specifying an event. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_WqlEventQuery-S/cs/WqlEventQuery-S.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery-S/vb/WqlEventQuery-S.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery-S/vb/WqlEventQuery-S.vb" id="Snippet1"::: + ]]> @@ -128,13 +128,13 @@ The condition to apply to events of the specified class. Initializes a new instance of the class for the specified event class name, with the specified condition. - @@ -163,21 +163,21 @@ A value specifying the latency acceptable for receiving this event. This value is used in cases where there is no explicit event provider for the query requested, and WMI is required to poll for the condition. This interval is the maximum amount of time that can pass before notification of an event must be delivered. Initializes a new instance of the class for the specified event class, with the specified latency time. - by specifying an event and a time span value specifying the latency acceptable for receiving this event. - + by specifying an event and a time span value specifying the latency acceptable for receiving this event. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_WqlEventQuery-S_T/cs/WqlEventQuery-S_T.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery-S_T/vb/WqlEventQuery-S_T.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery-S_T/vb/WqlEventQuery-S_T.vb" id="Snippet1"::: + ]]> @@ -208,13 +208,13 @@ The specified interval at which WMI sends one aggregate event, rather than many events. Initializes a new instance of the class with the specified event class name, condition, and grouping interval. - @@ -245,21 +245,21 @@ The condition to apply to events of the specified class. Initializes a new instance of the class with the specified event class name, polling interval, and condition. - @@ -292,13 +292,13 @@ The properties in the event class by which the events should be grouped. Initializes a new instance of the class with the specified event class name, condition, grouping interval, and grouping properties. - @@ -335,21 +335,20 @@ The condition to apply to the number of events. Initializes a new instance of the class with the specified event class name, condition, grouping interval, grouping properties, and specified number of events. - 15" which delivers aggregate events only if the number of **Win32_NTLogEvent** events received from the same source exceeds 15. - + 15", which delivers aggregate events only if the number of **Win32_NTLogEvent** events received from the same source exceeds 15. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_WqlEventQuery-S_T_S_T_S_S/cs/WqlEventQuery-S_T_S_T_S_S.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery-S_T_S_T_S_S/vb/WqlEventQuery-S_T_S_T_S_S.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery-S_T_S_T_S_S/vb/WqlEventQuery-S_T_S_T_S_S.vb" id="Snippet1"::: + ]]> @@ -376,13 +375,13 @@ Builds the query string according to the current property values. - @@ -410,13 +409,13 @@ Creates a copy of the object. The copied object. - @@ -444,25 +443,25 @@ Gets or sets the condition to be applied to events of the specified class. Returns a value containing the condition or conditions in the event query. - \ \ combined with logical operators. \ must represent a property defined on the event class specified in this query. - -## .NET Framework Security - Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see [Using Libraries from Partially Trusted Code](/dotnet/framework/misc/using-libraries-from-partially-trusted-code). - - - -## Examples - The following example initializes a new and displays the event query string. - + \ \ combined with logical operators. \ must represent a property defined on the event class specified in this query. + +## .NET Framework Security + Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see [Using Libraries from Partially Trusted Code](/dotnet/framework/misc/using-libraries-from-partially-trusted-code). + + + +## Examples + The following example initializes a new and displays the event query string. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_WqlEventQuery_Condition/cs/WqlEventQuery_Condition.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery_Condition/vb/WqlEventQuery_Condition.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery_Condition/vb/WqlEventQuery_Condition.vb" id="Snippet1"::: + ]]> @@ -489,25 +488,25 @@ Gets or sets the event class to query. Returns a value containing the name of the event class in the event query. - and displays the event query string. - + and displays the event query string. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_WqlEventQuery_EventClassName/cs/WqlEventQuery_EventClassName.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery_EventClassName/vb/WqlEventQuery_EventClassName.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery_EventClassName/vb/WqlEventQuery_EventClassName.vb" id="Snippet1"::: + ]]> @@ -534,25 +533,25 @@ Gets or sets properties in the event to be used for grouping events of the same type. Returns a containing the properties in the event to be used for grouping events of the same type. - and displays the event query string. - + and displays the event query string. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_WqlEventQuery_GroupByPropertyList/cs/WqlEventQuery_GroupByPropertyList.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery_GroupByPropertyList/vb/WqlEventQuery_GroupByPropertyList.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery_GroupByPropertyList/vb/WqlEventQuery_GroupByPropertyList.vb" id="Snippet1"::: + ]]> @@ -579,25 +578,25 @@ Gets or sets the interval to be used for grouping events of the same type. Returns a value containing the interval used for grouping events of the same type. - and displays the event query string. - + and displays the event query string. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_WqlEventQuery_GroupWithinInterval/cs/WqlEventQuery_GroupWithinInterval.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery_GroupWithinInterval/vb/WqlEventQuery_GroupWithinInterval.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery_GroupWithinInterval/vb/WqlEventQuery_GroupWithinInterval.vb" id="Snippet1"::: + ]]> @@ -624,25 +623,25 @@ Gets or sets the condition to be applied to the aggregation of events, based on the number of events received. Returns a value containing the condition applied to the aggregation of events, based on the number of events received. - \". - -## .NET Framework Security - Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see [Using Libraries from Partially Trusted Code](/dotnet/framework/misc/using-libraries-from-partially-trusted-code). - - - -## Examples - The following example initializes a new and displays the event query string. - + \". + +## .NET Framework Security + Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see [Using Libraries from Partially Trusted Code](/dotnet/framework/misc/using-libraries-from-partially-trusted-code). + + + +## Examples + The following example initializes a new and displays the event query string. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_WqlEventQuery_HavingCondition/cs/WqlEventQuery_HavingCondition.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery_HavingCondition/vb/WqlEventQuery_HavingCondition.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery_HavingCondition/vb/WqlEventQuery_HavingCondition.vb" id="Snippet1"::: + ]]> @@ -672,13 +671,13 @@ The query string to be parsed. Parses the query string and sets the property values accordingly. - @@ -705,16 +704,16 @@ Gets the language of the query. Returns a value that contains the query language that the query is written in. - @@ -741,24 +740,24 @@ Gets or sets the string representing the query. Returns a value containing the query. - and displays the event query string. - + and displays the event query string. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_WqlEventQuery_QueryString/cs/WqlEventQuery_QueryString.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery_QueryString/vb/WqlEventQuery_QueryString.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery_QueryString/vb/WqlEventQuery_QueryString.vb" id="Snippet1"::: + ]]> @@ -785,27 +784,27 @@ Gets or sets the polling interval to be used in this query. Returns a value containing the polling interval used in the event query. - value if polling is required. - -## .NET Framework Security - Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see [Using Libraries from Partially Trusted Code](/dotnet/framework/misc/using-libraries-from-partially-trusted-code). - - - -## Examples - The following example initializes a new that represents the query: "SELECT * FROM __InstanceCreationEvent *WITHIN* 1 WHERE TargetInstance ISA 'Win32_Process'". - + value if polling is required. + +## .NET Framework Security + Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see [Using Libraries from Partially Trusted Code](/dotnet/framework/misc/using-libraries-from-partially-trusted-code). + + + +## Examples + The following example initializes a new that represents the query: "SELECT * FROM __InstanceCreationEvent *WITHIN* 1 WHERE TargetInstance ISA 'Win32_Process'". + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WindowsServer/wminet_WqlEventQuery_WithinInterval/cs/WqlEventQuery_WithinInterval.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery_WithinInterval/vb/WqlEventQuery_WithinInterval.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WindowsServer/wminet_WqlEventQuery_WithinInterval/vb/WqlEventQuery_WithinInterval.vb" id="Snippet1"::: + ]]> diff --git a/xml/System.Messaging/MessageQueueAccessControlEntry.xml b/xml/System.Messaging/MessageQueueAccessControlEntry.xml index 5077397af25..ea6d89b6e83 100644 --- a/xml/System.Messaging/MessageQueueAccessControlEntry.xml +++ b/xml/System.Messaging/MessageQueueAccessControlEntry.xml @@ -18,21 +18,21 @@ Specifies access rights for a trustee (user, group, or computer) to perform Message Queuing tasks. - class to specify rights to apply to a trustee. These rights include peeking, receiving, or sending messages; viewing or modifying queue properties or permissions; and deleting queues. The class's method provides overloads for passing an instance of this class directly into the method, or adding it to an instance of so that you can add rights for more than one trustee at a time. The new access right is appended to the end of the queue's discretionary access control list (DACL), which identifies the users and groups that can access the queue. - - There are some exceptions to this generalization about where the new right is added and its effects. For more information, see . - - An overload of the constructor allows you specify a member to indicate whether to allow or deny rights to the trustee. The order in which rights are allowed or denied in the resource's DACL affects whether the trustee has the specified rights. For example, if rights have already been granted to the trustee and you later add an entry that denies them, the system finds the granted rights first, so the user is granted rights you might have intended they be denied. You can use two entry types to override this behavior: `Set` and `Revoke`. For more information about controlling the way in which access rights are determined, see the enumeration topic. - - The class is associated with security based on access control lists (ACLs), which you can use to give users access to the Message Queuing system itself. This is different from code access security, which is implemented through the and related classes. Message Queuing code access security defines queue-specific operations or queue access that an application might require which is subject to security control; it does not represent a right for the application to perform these operations or receive access in and of itself. See the topic [Code Access Security](/dotnet/framework/misc/code-access-security) for more information about code access security. - - To set message queue permissions for a trustee, create a new instance of the class and pass it into an overload of the constructor. Specify the message queue access rights either by passing an instance of into the constructor or by setting the property on an existing instance. - - You can then pass the instance directly to the method, or alternately add the entry to an instance of before calling . - + class to specify rights to apply to a trustee. These rights include peeking, receiving, or sending messages; viewing or modifying queue properties or permissions; and deleting queues. The class's method provides overloads for passing an instance of this class directly into the method, or adding it to an instance of so that you can add rights for more than one trustee at a time. The new access right is appended to the end of the queue's discretionary access control list (DACL), which identifies the users and groups that can access the queue. + + There are some exceptions to this generalization about where the new right is added and its effects. For more information, see . + + An overload of the constructor allows you specify a member to indicate whether to allow or deny rights to the trustee. The order in which rights are allowed or denied in the resource's DACL affects whether the trustee has the specified rights. For example, if rights have already been granted to the trustee and you later add an entry that denies them, the system finds the granted rights first, so the user is granted rights you might have intended they be denied. You can use two entry types to override this behavior: `Set` and `Revoke`. For more information about controlling the way in which access rights are determined, see the enumeration topic. + + The class is associated with security based on access control lists (ACLs), which you can use to give users access to the Message Queuing system itself. This is different from code access security, which is implemented through the and related classes. Message Queuing code access security defines queue-specific operations or queue access that an application might require that is subject to security control; it does not represent a right for the application to perform these operations or receive access in and of itself. See the topic [Code Access Security](/dotnet/framework/misc/code-access-security) for more information about code access security. + + To set message queue permissions for a trustee, create a new instance of the class and pass it into an overload of the constructor. Specify the message queue access rights either by passing an instance of into the constructor or by setting the property on an existing instance. + + You can then pass the instance directly to the method, or alternately add the entry to an instance of before calling . + ]]> @@ -74,13 +74,13 @@ A bitwise combination of the values which defines the combination of rights to grant to the trustee. Initializes a new instance of the class, granting the specified Message Queuing access rights to the specified trustee. - bitflag, which includes such rights as receiving messages, deleting queues, and setting queue properties. The constructor uses the rights you pass in to set this instance's property. - - Pass this instance of directly into an overload of the method to grant rights only to this trustee, or add this instance to a before calling to grant or deny rights to multiple trustees at once. - + bitflag, which includes such rights as receiving messages, deleting queues, and setting queue properties. The constructor uses the rights you pass in to set this instance's property. + + Pass this instance of directly into an overload of the method to grant rights only to this trustee, or add this instance to a before calling to grant or deny rights to multiple trustees at once. + ]]> @@ -114,15 +114,15 @@ One of the values, which specifies whether to allow, deny, set or revoke the specified rights. Initializes a new instance of the class, with the specified trustee and Message Queuing access rights. The type of access (such as or ) is defined by the entry type you pass in. - bitflag, which includes such rights as receiving messages, deleting queues, and setting queue properties. The constructor uses the rights you pass in to set this instance's property. - - For more information about granting or denying rights, see the topic. For two members, `Allow` and `Deny`, there may be preexisting and possibly contradictory access rights, so the order in which the rights appear in the queue's discretionary access control list (DACL) affects whether the right is ultimately granted. Two other members, `Set` and `Revoke`, overwrite any existing rights. Use the member whose behavior is applicable to your application. - - Pass this instance of directly into an overload of the method to grant or deny rights only to this trustee, or add this instance to a before calling to grant or deny rights to multiple trustees at once. - + bitflag, which includes such rights as receiving messages, deleting queues, and setting queue properties. The constructor uses the rights you pass in to set this instance's property. + + For more information about granting or denying rights, see the topic. For two members, `Allow` and `Deny`, there may be preexisting and possibly contradictory access rights, so the order in which the rights appear in the queue's discretionary access control list (DACL) affects whether the right is ultimately granted. Two other members, `Set` and `Revoke`, overwrite any existing rights. Use the member whose behavior is applicable to your application. + + Pass this instance of directly into an overload of the method to grant or deny rights only to this trustee, or add this instance to a before calling to grant or deny rights to multiple trustees at once. + ]]> @@ -152,11 +152,11 @@ Gets or sets the set of Message Queuing-specific rights to apply to the trustee. A bitwise combination of the members. The default is defined by the parameter passed into the constructor. - property enables you to specify Message Queuing object-specific rights such as receiving, peeking, or writing messages, or setting queue properties. The value of this property is set by the constructor, but you can change it at any time before using this instance of in a call to . - + property enables you to specify Message Queuing object-specific rights such as receiving, peeking, or writing messages, or setting queue properties. The value of this property is set by the constructor, but you can change it at any time before using this instance of in a call to . + ]]> diff --git a/xml/System.Printing/PrintQueue.xml b/xml/System.Printing/PrintQueue.xml index 741eb39b484..163a3c80e71 100644 --- a/xml/System.Printing/PrintQueue.xml +++ b/xml/System.Printing/PrintQueue.xml @@ -649,7 +649,7 @@ ## Remarks If `fastCopy` is `true`, then the printer must be an [Printing Overview](https://learn.microsoft.com/dotnet/framework/wpf/advanced/printing-overview). If it is not, the method throws an exception. - If `fastCopy` is `false`, then it is not necessary to use an XPSDrv printer. The XPS file being added to the queue is converted to the printer's page description language, such as PCL or Postscript. However, this kind of printing makes a call to Component Object Model (COM). The call to COM requires that the calling thread have a single-threaded apartment () instead of multiple-threaded apartment () which is the default in Microsoft .NET 2.0 and later. (For more on threading and apartment states, see [Managed and Unmanaged Threading](https://msdn.microsoft.com/library/db425c20-4b2f-4433-bf96-76071c7881e5), and .) There are two ways of doing this: + If `fastCopy` is `false`, then it is not necessary to use an XPSDrv printer. The XPS file being added to the queue is converted to the printer's page description language, such as PCL or Postscript. However, this kind of printing makes a call to Component Object Model (COM). The call to COM requires that the calling thread have a single-threaded apartment () instead of multiple-threaded apartment (), which is the default. There are two ways of doing this: - The simplest way is to add the (that is, "`[System.STAThreadAttribute()]`") just above the first line of the application's `Main` method (usually "`static void Main(string[] args)`"). @@ -937,7 +937,7 @@ has no public constructor. Hence, the variable `documentImageableArea` must be declared and assigned to `null` and only then passed to the method. This method displays a requiring input from the user. After the user has selected a printer, paper size, and orientation and closed the dialog, `documentImageableArea` points to an actual object and its properties are initialized. @@ -1080,7 +1080,7 @@ has no public constructor. Hence, the variable `documentImageableArea` must be declared and assigned to `null` and only then passed to the method. This method displays a requiring input from the user. After the user has selected a printer, paper size, and orientation and closed the dialog, `documentImageableArea` points to an actual object, and its properties are initialized. @@ -1138,7 +1138,7 @@ has no public constructor. Hence, the variable `documentImageableArea` must be declared and assigned to `null` and only then passed to the method. This method displays a requiring input from the user. The user configures their print job on the dialog (including selecting a printer, paper size, orientation, and page range). When the dialog is closed, `pageRangeSelection` and `pageRange` have values, and `documentImageableArea` points to an actual object whose properties are initialized. @@ -1194,7 +1194,7 @@ has no public constructor. Hence, the variable `documentImageableArea` must be declared and assigned to `null` and only then passed to the method. This method displays a requiring input from the user. The user configures their print job on the dialog (including selecting a printer, paper size, orientation, and page range). When the dialog is closed, `pageRangeSelection` and `pageRange` have values, and `documentImageableArea` points to an actual object whose properties are initialized. diff --git a/xml/System.ServiceProcess/ServiceBase.xml b/xml/System.ServiceProcess/ServiceBase.xml index de5041a0786..57548927eda 100644 --- a/xml/System.ServiceProcess/ServiceBase.xml +++ b/xml/System.ServiceProcess/ServiceBase.xml @@ -1097,7 +1097,7 @@ - A which indicates a service to start. + A that indicates a service to start. Registers the executable for a service with the Service Control Manager (SCM). Specifies the to check. - Gets a value which indicates whether the session state is read-only for the specified . + Gets a value that indicates whether the session state is read-only for the specified . if the session state is read-only; otherwise, . To be added. @@ -238,7 +238,7 @@ Specifies the to check. - Gets a value which indicates whether the session state is required for the specified . + Gets a value that indicates whether the session state is required for the specified . if the session state is required; otherwise, . To be added. diff --git a/xml/System.Windows/Application.xml b/xml/System.Windows/Application.xml index 47b9ad209f8..66370d1f13c 100644 --- a/xml/System.Windows/Application.xml +++ b/xml/System.Windows/Application.xml @@ -1747,14 +1747,12 @@ For more information about XBAP support, see [Frequently asked questions about W exposes a dictionary via which you can use to store application-scope properties. This allows you to share state amongst all code in an in a thread-safe fashion, without the need to write your own state code. + exposes a dictionary via that you can use to store application-scope properties. This allows you to share state amongst all code in an in a thread-safe fashion, without the need to write your own state code. Properties stored in must be converted to the appropriate type returned. The property is thread safe and is available from any thread. - - ## Examples The following example shows how create and use an application-scope property using . diff --git a/xml/System.Windows/CornerRadiusConverter.xml b/xml/System.Windows/CornerRadiusConverter.xml index 8480f013e22..6776abbef9b 100644 --- a/xml/System.Windows/CornerRadiusConverter.xml +++ b/xml/System.Windows/CornerRadiusConverter.xml @@ -166,7 +166,7 @@ is . - is not and is not a valid type which can be converted to a . + is not and is not a valid type that can be converted to a . @@ -212,11 +212,11 @@ Converts the specified to the specified type. The object created from converting this (a string). - . - + . + ]]> diff --git a/xml/System.Windows/FigureUnitType.xml b/xml/System.Windows/FigureUnitType.xml index 238bf4348b9..a1197318c5b 100644 --- a/xml/System.Windows/FigureUnitType.xml +++ b/xml/System.Windows/FigureUnitType.xml @@ -22,17 +22,17 @@ Describes the unit type associated with the width or height of a . - , the of the decreases. Below is the XAML for the sample. - - :::code language="xaml" source="~/snippets/csharp/System.Windows/BaselineAlignment/Overview/figurelengthexample.xaml" id="Snippetfigurelengthexamplewholepage"::: - - Below is the code used to decrease the of the using the Pixel to specify the unit type. - - :::code language="csharp" source="~/snippets/csharp/System.Windows/BaselineAlignment/Overview/figurelengthexample.xaml.cs" id="Snippetfigurelengthcodebehindexamplewholepage"::: - + , the of the decreases. Below is the XAML for the sample. + + :::code language="xaml" source="~/snippets/csharp/System.Windows/BaselineAlignment/Overview/figurelengthexample.xaml" id="Snippetfigurelengthexamplewholepage"::: + + Below is the code used to decrease the of the using the Pixel to specify the unit type. + + :::code language="csharp" source="~/snippets/csharp/System.Windows/BaselineAlignment/Overview/figurelengthexample.xaml.cs" id="Snippetfigurelengthcodebehindexamplewholepage"::: + ]]> @@ -61,7 +61,7 @@ 0 - Default value when the is not specified which creates a value for the width or height of the that is calculated without constraints. **Note:** When is set to , the property of is set to 1. + Default value when the is not specified that creates a value for the width or height of the that is calculated without constraints. **Note:** When is set to , the property of is set to 1. diff --git a/xml/System.Windows/FontSizeConverter.xml b/xml/System.Windows/FontSizeConverter.xml index 27c7dbc8337..07b2963b520 100644 --- a/xml/System.Windows/FontSizeConverter.xml +++ b/xml/System.Windows/FontSizeConverter.xml @@ -23,11 +23,11 @@ Converts font size values to and from other type representations. - object supports conversion to and from the following types: include , , , and . There is no actual `FontSize` type, but values for font sizes are generally typed as , so the converter's destination type is . - + object supports conversion to and from the following types: include , , , and . There is no actual `FontSize` type, but values for font sizes are generally typed as , so the converter's destination type is . + ]]> @@ -165,7 +165,7 @@ Context information of a component such as its container and . Cultural specific information, including the writing system and calendar used. - The value which is being converted to a font size value. + The value that is being converted to a font size value. Converts a specified type to a . A value that represents the converted font size value. To be added. diff --git a/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompilerParameters.xml b/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompilerParameters.xml index 6efeeeb0c44..09c2f0e908e 100644 --- a/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompilerParameters.xml +++ b/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompilerParameters.xml @@ -27,21 +27,21 @@ Represents parameters passed to during the compilation process. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - - -## Examples - The following code example demonstrates how to create a new instance of the class, add and set the value for the property. The code also creates a new instance of the class and runs the method. This code assumes that `results` is of type . This code example is part of the Outlook Workflow Wizard SDK Sample from the WizardForm.cs file. For more information, see [Outlook Workflow Wizard](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741721(v=vs.90)). - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + + +## Examples + The following code example demonstrates how to create a new instance of the class, add and set the value for the property. The code also creates a new instance of the class and runs the method. This code assumes that `results` is of type . This code example is part of the Outlook Workflow Wizard SDK Sample from the WizardForm.cs file. For more information, see [Outlook Workflow Wizard](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741721(v=vs.90)). + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet99"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet99"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet99"::: + ]]> @@ -93,14 +93,14 @@ The names of the assemblies used in compilation. Initializes a new instance of the class, with the names of the assemblies used in compilation. - class, add and set the value for the property. The code also creates a new instance of the class and runs the method. This code assumes that `results` is of type . This code example is part of the Outlook Workflow Wizard SDK Sample from the WizardForm.cs file. For more information, see [Outlook Workflow Wizard](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741721(v=vs.90)). - + class, add and set the value for the property. The code also creates a new instance of the class and runs the method. This code assumes that `results` is of type . This code example is part of the Outlook Workflow Wizard SDK Sample from the WizardForm.cs file. For more information, see [Outlook Workflow Wizard](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741721(v=vs.90)). + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet99"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet99"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet99"::: + ]]> @@ -215,7 +215,7 @@ System.Boolean - Gets or sets a value which indicates whether to generate only a , or to call the C# or Visual Basic compiler to generate the executable or DLL. + Gets or sets a value that indicates whether to generate only a , or to call the C# or Visual Basic compiler to generate the executable or DLL. A value which indicates whether to generate only a , or to call the C# or Visual Basic compiler to generate the executable or DLL. To be added. @@ -262,19 +262,19 @@ Gets the property that represents a collection of directory names under which compiler looks for referenced assemblies. The property that represents a collection of directory names under which compiler looks for referenced assemblies. - class, add and set the value for the property. The code also creates a new instance of the class and runs the method. This code assumes that `results` is of type . This code example is part of the Outlook Workflow Wizard SDK Sample from the WizardForm.cs file. For more information, see [Outlook Workflow Wizard](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741721(v=vs.90)). - + class, add and set the value for the property. The code also creates a new instance of the class and runs the method. This code assumes that `results` is of type . This code example is part of the Outlook Workflow Wizard SDK Sample from the WizardForm.cs file. For more information, see [Outlook Workflow Wizard](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741721(v=vs.90)). + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet99"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet99"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet99"::: + ]]>