From 8680e377b9b3383e9b5288b47120fab58e1d5acc Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 28 Mar 2025 12:47:17 -0700 Subject: [PATCH] fix that/which grammar --- .../BinaryExpression.xml | 2 +- xml/System.Linq.Expressions/Expression.xml | 8 +- .../LabelExpression.xml | 4 +- .../LambdaExpression.xml | 4 +- .../ListInitExpression.xml | 42 +- .../MemberInitExpression.xml | 42 +- .../UnaryExpression.xml | 86 +- xml/System.Linq/ParallelEnumerable.xml | 4 +- xml/System.Reflection.Emit/DynamicMethod.xml | 4 +- .../AmbiguousMatchException.xml | 92 +- .../AssemblyDelaySignAttribute.xml | 38 +- .../CustomAttributeFormatException.xml | 80 +- xml/System.Reflection/FieldInfo.xml | 2 +- .../InvalidFilterCriteriaException.xml | 82 +- xml/System.Reflection/ParameterInfo.xml | 2 +- xml/System.Reflection/PropertyInfo.xml | 2 +- .../TargetInvocationException.xml | 66 +- .../TargetParameterCountException.xml | 74 +- xml/System.Runtime.Caching/ChangeMonitor.xml | 4 +- .../CallSiteBinder.xml | 2 +- .../MethodImplAttribute.xml | 2 +- .../StrongBox`1.xml | 12 +- .../InstanceLockedException.xml | 14 +- .../InstancePersistenceContext.xml | 294 ++--- .../ITypeInfo2.xml | 238 ++-- .../JSMarshalerArgument.xml | 68 +- .../ExternalException.xml | 128 +- .../InvalidComObjectException.xml | 2 +- .../InvalidOleVariantTypeException.xml | 2 +- .../MarshalDirectiveException.xml | 2 +- .../SafeArrayRankMismatchException.xml | 2 +- .../SafeArrayTypeMismatchException.xml | 2 +- .../UCOMIStream.xml | 122 +- xml/System.Runtime.Intrinsics/Vector128.xml | 2 +- xml/System.Runtime.Intrinsics/Vector256.xml | 2 +- xml/System.Runtime.Intrinsics/Vector512.xml | 2 +- xml/System.Runtime.Intrinsics/Vector64.xml | 6 +- ...yLoadContext+ContextualReflectionScope.xml | 4 +- .../AssemblyLoadContext.xml | 4 +- .../AsyncResult.xml | 262 ++-- .../ISafeSerializationData.xml | 20 +- xml/System.Security.Claims/Claim.xml | 114 +- .../CmsSigner.xml | 170 +-- .../Pkcs12Builder.xml | 2 +- .../Pkcs12CertBag.xml | 8 +- .../Pkcs12Info.xml | 28 +- .../Pkcs12SafeContents.xml | 64 +- .../Pkcs12SecretBag.xml | 4 +- .../Rfc3161TimestampToken.xml | 6 +- .../CertificateRequest.xml | 12 +- .../CipherData.xml | 202 +-- .../CipherReference.xml | 212 +-- .../EncryptedXml.xml | 1156 ++++++++--------- .../DSAOpenSsl.xml | 4 +- .../ECDiffieHellmanOpenSsl.xml | 68 +- .../SP800108HmacCounterKdf.xml | 45 +- xml/System.Security.Cryptography/Shake128.xml | 2 +- xml/System.Security.Cryptography/Shake256.xml | 2 +- .../StrongNameIdentityPermission.xml | 304 ++--- .../ContentGrant.xml | 46 +- .../JsonParameterInfo.xml | 2 +- xml/System.Text.Json/JsonSerializer.xml | 4 +- xml/System.Text/CodePagesEncodingProvider.xml | 4 +- xml/System.Text/EncodingExtensions.xml | 2 +- xml/ns-System.ComponentModel.Design.xml | 78 +- xml/ns-System.Net.PeerToPeer.xml | 12 +- ...System.Runtime.InteropServices.Expando.xml | 2 +- xml/ns-System.ServiceProcess.xml | 2 +- xml/ns-System.Speech.Recognition.xml | 18 +- xml/ns-System.Threading.Tasks.xml | 4 +- xml/ns-System.Xml.Resolvers.xml | 4 +- xml/ns-System.Xml.xml | 67 +- 72 files changed, 2214 insertions(+), 2264 deletions(-) diff --git a/xml/System.Linq.Expressions/BinaryExpression.xml b/xml/System.Linq.Expressions/BinaryExpression.xml index 8268efaf1aa..ca99287c50e 100644 --- a/xml/System.Linq.Expressions/BinaryExpression.xml +++ b/xml/System.Linq.Expressions/BinaryExpression.xml @@ -486,7 +486,7 @@ ## Remarks If CanReduce returns true, this should return a valid expression. - This method can return another node which itself must be reduced. + This method can return another node that itself must be reduced. ]]> diff --git a/xml/System.Linq.Expressions/Expression.xml b/xml/System.Linq.Expressions/Expression.xml index eb711d81fc7..e4e63951b46 100644 --- a/xml/System.Linq.Expressions/Expression.xml +++ b/xml/System.Linq.Expressions/Expression.xml @@ -9551,7 +9551,7 @@ As with `Func`, the last argument is the return type. It can be set to `System.V - The which this will be associated with. + The that this will be associated with. Creates a representing a label without a default value. A without a default value. To be added. @@ -9722,7 +9722,7 @@ As with `Func`, the last argument is the return type. It can be set to `System.V - The which this will be associated with. + The that this will be associated with. The value of this when the label is reached through regular control flow. Creates a representing a label with the given default value. A with the given default value. @@ -20051,7 +20051,7 @@ As with `Func`, the last argument is the return type. It can be set to `System.V - Reduces this node to a simpler expression. If CanReduce returns true, this should return a valid expression. This method can return another node which itself must be reduced. + Reduces this node to a simpler expression. If CanReduce returns true, this should return a valid expression. This method can return another node that itself must be reduced. The reduced expression. To be added. @@ -20094,7 +20094,7 @@ As with `Func`, the last argument is the return type. It can be set to `System.V - Reduces this node to a simpler expression. If CanReduce returns true, this should return a valid expression. This method can return another node which itself must be reduced. + Reduces this node to a simpler expression. If CanReduce returns true, this should return a valid expression. This method can return another node that itself must be reduced. The reduced expression. System.Linq.Expressions.LabelTarget - The which this label is associated with. - The which this label is associated with. + The that this label is associated with. + The that this label is associated with. To be added. diff --git a/xml/System.Linq.Expressions/LambdaExpression.xml b/xml/System.Linq.Expressions/LambdaExpression.xml index f8058949ab2..81a8acebb06 100644 --- a/xml/System.Linq.Expressions/LambdaExpression.xml +++ b/xml/System.Linq.Expressions/LambdaExpression.xml @@ -329,7 +329,7 @@ - A which will be used to hold the lambda's IL. + A that will be used to hold the lambda's IL. Compiles the lambda into a method definition. To be added. @@ -360,7 +360,7 @@ - A which will be used to hold the lambda's IL. + A that will be used to hold the lambda's IL. Debugging information generator used by the compiler to mark sequence points and annotate local variables. Compiles the lambda into a method definition and custom debug information. To be added. diff --git a/xml/System.Linq.Expressions/ListInitExpression.xml b/xml/System.Linq.Expressions/ListInitExpression.xml index bd7b697a908..cacf1982a2a 100644 --- a/xml/System.Linq.Expressions/ListInitExpression.xml +++ b/xml/System.Linq.Expressions/ListInitExpression.xml @@ -57,21 +57,21 @@ Represents a constructor call that has a collection initializer. - factory methods to create a . - - The value of the property of a is . - - - -## Examples - The following example creates a that represents the initialization of a new dictionary instance that has two key-value pairs. - + factory methods to create a . + + The value of the property of a is . + + + +## Examples + The following example creates a that represents the initialization of a new dictionary instance that has two key-value pairs. + :::code language="csharp" source="~/snippets/csharp/System.Linq.Expressions/BinaryExpression/Overview/Expression.cs" id="Snippet7"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Linq.Expressions.Expression/VB/Expression.vb" id="Snippet7"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Linq.Expressions.Expression/VB/Expression.vb" id="Snippet7"::: + ]]> @@ -346,13 +346,13 @@ Reduces the binary expression node to a simpler expression. The reduced expression. - diff --git a/xml/System.Linq.Expressions/MemberInitExpression.xml b/xml/System.Linq.Expressions/MemberInitExpression.xml index 3ae56db7783..82cfb2b8d93 100644 --- a/xml/System.Linq.Expressions/MemberInitExpression.xml +++ b/xml/System.Linq.Expressions/MemberInitExpression.xml @@ -57,21 +57,21 @@ Represents calling a constructor and initializing one or more members of the new object. - factory methods to create a . - - The value of the property of a is . - - - -## Examples - The following example creates a that represents the initialization of two members of a new object. - + factory methods to create a . + + The value of the property of a is . + + + +## Examples + The following example creates a that represents the initialization of two members of a new object. + :::code language="csharp" source="~/snippets/csharp/System.Linq.Expressions/BinaryExpression/Overview/Expression.cs" id="Snippet9"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Linq.Expressions.Expression/VB/Expression.vb" id="Snippet9"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Linq.Expressions.Expression/VB/Expression.vb" id="Snippet9"::: + ]]> @@ -346,13 +346,13 @@ Reduces the to a simpler expression. The reduced expression. - diff --git a/xml/System.Linq.Expressions/UnaryExpression.xml b/xml/System.Linq.Expressions/UnaryExpression.xml index ef4726a72f5..b9a9c4a5c6d 100644 --- a/xml/System.Linq.Expressions/UnaryExpression.xml +++ b/xml/System.Linq.Expressions/UnaryExpression.xml @@ -57,33 +57,33 @@ Represents an expression that has a unary operator. - that has a specific node type. - -||Factory Method| -|----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -||| -||| -||| -||| -||| -||| -||| -||| -||| - - In addition, the methods can also be used to create a . These factory methods can be used to create a of any node type that represents a unary operation. The parameter of these methods that is of type specifies the desired node type. - - - -## Examples - The following example creates a object that represents the reference conversion of a non-nullable integer expression to the nullable integer type. - + that has a specific node type. + +||Factory Method| +|----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +||| +||| +||| +||| +||| +||| +||| +||| +||| + + In addition, the methods can also be used to create a . These factory methods can be used to create a of any node type that represents a unary operation. The parameter of these methods that is of type specifies the desired node type. + + + +## Examples + The following example creates a object that represents the reference conversion of a non-nullable integer expression to the nullable integer type. + :::code language="csharp" source="~/snippets/csharp/System.Linq.Expressions/BinaryExpression/Overview/Expression.cs" id="Snippet11"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Linq.Expressions.Expression/VB/Expression.vb" id="Snippet11"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Linq.Expressions.Expression/VB/Expression.vb" id="Snippet11"::: + ]]> @@ -219,11 +219,11 @@ if the node represents a lifted call; otherwise, . - @@ -270,11 +270,11 @@ if the operator's return type is lifted to a nullable type; otherwise, . - is `true`, the operator returns a nullable type and if the nullable operand evaluates to `null`, the operator returns `null`. - + is `true`, the operator returns a nullable type and if the nullable operand evaluates to `null`, the operator returns `null`. + ]]> @@ -471,13 +471,13 @@ Reduces the expression node to a simpler expression. The reduced expression. - diff --git a/xml/System.Linq/ParallelEnumerable.xml b/xml/System.Linq/ParallelEnumerable.xml index 242cb8e2efc..2755a66036f 100644 --- a/xml/System.Linq/ParallelEnumerable.xml +++ b/xml/System.Linq/ParallelEnumerable.xml @@ -787,7 +787,7 @@ The input sequence. Enables treatment of a data source as if it were ordered, overriding the default of unordered. AsOrdered may only be invoked on non-generic sequences returned by AsParallel, ParallelEnumerable.Range, and ParallelEnumerable.Repeat. - The source sequence which will maintain the original ordering in the subsequent query operators. + The source sequence that will maintain the original ordering in the subsequent query operators. The type of elements of . The input sequence. Enables treatment of a data source as if it were ordered, overriding the default of unordered. AsOrdered may only be invoked on generic sequences returned by AsParallel, ParallelEnumerable.Range, and ParallelEnumerable.Repeat. - The source sequence which will maintain the original ordering in the subsequent query operators. + The source sequence that will maintain the original ordering in the subsequent query operators. property of a dynamic method. This code example is part of a larger example provided for the class. diff --git a/xml/System.Reflection/AmbiguousMatchException.xml b/xml/System.Reflection/AmbiguousMatchException.xml index 2c510726249..4ee15590a3f 100644 --- a/xml/System.Reflection/AmbiguousMatchException.xml +++ b/xml/System.Reflection/AmbiguousMatchException.xml @@ -82,13 +82,13 @@ The exception that is thrown when binding to a member results in more than one member matching the binding criteria. This class cannot be inherited. - or ). - + or ). + ]]> @@ -148,16 +148,16 @@ Initializes a new instance of the class with an empty message string and the root cause exception set to . - . This constructor sets the properties of the `Exception` object as shown in the following table. - -|Property|Value| -|--------------|-----------| -||`null`| -||The empty string ("").| - + . This constructor sets the properties of the `Exception` object as shown in the following table. + +|Property|Value| +|--------------|-----------| +||`null`| +||The empty string ("").| + ]]> @@ -210,16 +210,16 @@ A string indicating the reason this exception was thrown. Initializes a new instance of the class with its message string set to the given message and the root cause exception set to . - . This constructor sets the properties of the `Exception` object as shown in the following table. - -|Property|Value| -|--------------|-----------| -||`null`| -||The `message` string.| - + . This constructor sets the properties of the `Exception` object as shown in the following table. + +|Property|Value| +|--------------|-----------| +||`null`| +||The `message` string.| + ]]> @@ -272,27 +272,27 @@ The exception that is the cause of the current exception. If the parameter is not , the current exception is raised in a block that handles the inner exception. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. - property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. - - The following table shows the initial property values for an instance of . - -|Property|Value| -|--------------|-----------| -||The inner exception reference.| -||The error message string.| - - - -## Examples - The following example shows two methods, each named `Mymethod`. One method takes an integer and the other takes a string. If an integer is passed to `Mymethod`, the first method is used. If a string is passed, the second method is used. If it cannot be determined which `Mymethod` to use, `AmbiguousMatchException` is thrown. - + property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. + + The following table shows the initial property values for an instance of . + +|Property|Value| +|--------------|-----------| +||The inner exception reference.| +||The error message string.| + + + +## Examples + The following example shows two methods, each named `Mymethod`. One method takes an integer and the other takes a string. If an integer is passed to `Mymethod`, the first method is used. If a string is passed, the second method is used. If it cannot be determined which `Mymethod` to use, `AmbiguousMatchException` is thrown. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_Classic/classic AmbiguousMatchException.AmbiguousMatchException2 Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Reflection/AmbiguousMatchException/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_Classic/classic AmbiguousMatchException.AmbiguousMatchException2 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_Classic/classic AmbiguousMatchException.AmbiguousMatchException2 Example/VB/source.vb" id="Snippet1"::: + ]]> diff --git a/xml/System.Reflection/AssemblyDelaySignAttribute.xml b/xml/System.Reflection/AssemblyDelaySignAttribute.xml index eb49333ccda..74fc664fd72 100644 --- a/xml/System.Reflection/AssemblyDelaySignAttribute.xml +++ b/xml/System.Reflection/AssemblyDelaySignAttribute.xml @@ -64,28 +64,28 @@ Specifies that the assembly is not fully signed when created. - attribute with the . To compile this example, you must create a strong-name key file named TestPublicKey.snk using the [Sn.exe (Strong Name Tool)](/dotnet/framework/tools/sn-exe-strong-name-tool): - -```console -sn -k TestPublicKey.snk -``` - - Compile the example as a .dll. If you compile from the command line, use the `/t:library` option for C# or Visual Basic, or the `/LD` linker option for Visual C++. - + +## Examples + The following code example shows the use of the attribute with the . To compile this example, you must create a strong-name key file named TestPublicKey.snk using the [Sn.exe (Strong Name Tool)](/dotnet/framework/tools/sn-exe-strong-name-tool): + +```console +sn -k TestPublicKey.snk +``` + + Compile the example as a .dll. If you compile from the command line, use the `/t:library` option for C# or Visual Basic, or the `/LD` linker option for Visual C++. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/AssemblyDelaySignAttribute/cpp/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Reflection/AssemblyDelaySignAttribute/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AssemblyDelaySignAttribute/vb/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AssemblyDelaySignAttribute/vb/source.vb" id="Snippet1"::: + ]]> Metadata and Self-Describing Components diff --git a/xml/System.Reflection/CustomAttributeFormatException.xml b/xml/System.Reflection/CustomAttributeFormatException.xml index 5407a68df47..bb358983f7c 100644 --- a/xml/System.Reflection/CustomAttributeFormatException.xml +++ b/xml/System.Reflection/CustomAttributeFormatException.xml @@ -59,13 +59,13 @@ The exception that is thrown when the binary format of a custom attribute is invalid. - @@ -118,18 +118,18 @@ Initializes a new instance of the class with the default properties. - |null| -||The empty string ("").| - + |null| +||The empty string ("").| + ]]> @@ -174,15 +174,15 @@ The message that indicates the reason this exception was thrown. Initializes a new instance of the class with the specified message. - |`null`| - + |`null`| + ]]> @@ -288,18 +288,18 @@ The exception that is the cause of the current exception. If the parameter is not , the current exception is raised in a block that handles the inner exception. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. - property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. - - The following table shows the initial property values for an instance of . - -|Property|Value| -|--------------|-----------| -||The `inner` exception.| -||The error message string.| - + property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. + + The following table shows the initial property values for an instance of . + +|Property|Value| +|--------------|-----------| +||The `inner` exception.| +||The error message string.| + ]]> diff --git a/xml/System.Reflection/FieldInfo.xml b/xml/System.Reflection/FieldInfo.xml index aa42ae6ee51..6b3e9afcc34 100644 --- a/xml/System.Reflection/FieldInfo.xml +++ b/xml/System.Reflection/FieldInfo.xml @@ -680,7 +680,7 @@ , and which are used to obtain custom modifiers from a function pointer. + A modified type supports , , and , which are used to obtain custom modifiers from a function pointer. To obtain the normal, unmodified type from a modified type, use . diff --git a/xml/System.Reflection/InvalidFilterCriteriaException.xml b/xml/System.Reflection/InvalidFilterCriteriaException.xml index 2266db76a86..a3b2716479b 100644 --- a/xml/System.Reflection/InvalidFilterCriteriaException.xml +++ b/xml/System.Reflection/InvalidFilterCriteriaException.xml @@ -79,11 +79,11 @@ The exception that is thrown in when the filter criteria is not valid for the type of filter you are using. - @@ -140,18 +140,18 @@ Initializes a new instance of the class with the default properties. - |null| -||The empty string ("").| - + |null| +||The empty string ("").| + ]]> @@ -200,18 +200,18 @@ The message text for the exception. Initializes a new instance of the class with the given HRESULT and message string. - property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. - - The following table shows the initial property values for an instance of . - -|Property|Value| -|--------------|-----------| -||`null`| -||The error message string.| - + property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. + + The following table shows the initial property values for an instance of . + +|Property|Value| +|--------------|-----------| +||`null`| +||The error message string.| + ]]> @@ -322,18 +322,18 @@ The exception that is the cause of the current exception. If the parameter is not , the current exception is raised in a block that handles the inner exception. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. - property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. - - The following table shows the initial property values for an instance of . - -|Property|Value| -|--------------|-----------| -||The inner exception reference.| -||The error message string.| - + property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. + + The following table shows the initial property values for an instance of . + +|Property|Value| +|--------------|-----------| +||The inner exception reference.| +||The error message string.| + ]]> diff --git a/xml/System.Reflection/ParameterInfo.xml b/xml/System.Reflection/ParameterInfo.xml index 2c76ef2beda..f5e95daeb0f 100644 --- a/xml/System.Reflection/ParameterInfo.xml +++ b/xml/System.Reflection/ParameterInfo.xml @@ -750,7 +750,7 @@ , and which are used to obtain custom modifiers from a function pointer. + A modified type supports , , and , which are used to obtain custom modifiers from a function pointer. To obtain the normal, unmodified type from a modified type, use . diff --git a/xml/System.Reflection/PropertyInfo.xml b/xml/System.Reflection/PropertyInfo.xml index fef88837481..10de1965426 100644 --- a/xml/System.Reflection/PropertyInfo.xml +++ b/xml/System.Reflection/PropertyInfo.xml @@ -1001,7 +1001,7 @@ , and which are used to obtain custom modifiers from a function pointer. + A modified type supports , , and , which are used to obtain custom modifiers from a function pointer. To obtain the normal, unmodified type from a modified type, use . diff --git a/xml/System.Reflection/TargetInvocationException.xml b/xml/System.Reflection/TargetInvocationException.xml index 6859281d200..d0116f2210f 100644 --- a/xml/System.Reflection/TargetInvocationException.xml +++ b/xml/System.Reflection/TargetInvocationException.xml @@ -82,15 +82,15 @@ The exception that is thrown by methods invoked through reflection. This class cannot be inherited. - . - - `TargetInvocationException` uses the HRESULT COR_E_TARGETINVOCATION which has the value 0x80131604. - - When created, the `TargetInvocationException` is passed a reference to the exception thrown by the method invoked through reflection. The property holds the underlying exception. - + . + + `TargetInvocationException` uses the HRESULT COR_E_TARGETINVOCATION, which has the value 0x80131604. + + When created, the `TargetInvocationException` is passed a reference to the exception thrown by the method invoked through reflection. The property holds the underlying exception. + ]]> @@ -155,18 +155,18 @@ The exception that is the cause of the current exception. If the parameter is not , the current exception is raised in a block that handles the inner exception. Initializes a new instance of the class with a reference to the inner exception that is the cause of this exception. - property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. - - The following table shows the initial property values for an instance of . - -|Property|Value| -|--------------|-----------| -||The inner exception reference.| -||The error message string.| - + property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. + + The following table shows the initial property values for an instance of . + +|Property|Value| +|--------------|-----------| +||The inner exception reference.| +||The error message string.| + ]]> @@ -221,18 +221,18 @@ The exception that is the cause of the current exception. If the parameter is not , the current exception is raised in a block that handles the inner exception. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. - property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. - - The following table shows the initial property values for an instance of . - -|Property|Value| -|--------------|-----------| -||The inner exception reference.| -||The error message string.| - + property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. + + The following table shows the initial property values for an instance of . + +|Property|Value| +|--------------|-----------| +||The inner exception reference.| +||The error message string.| + ]]> diff --git a/xml/System.Reflection/TargetParameterCountException.xml b/xml/System.Reflection/TargetParameterCountException.xml index ea146bbfdb5..f9ad3298df3 100644 --- a/xml/System.Reflection/TargetParameterCountException.xml +++ b/xml/System.Reflection/TargetParameterCountException.xml @@ -82,11 +82,11 @@ The exception that is thrown when the number of parameters for an invocation does not match the number expected. This class cannot be inherited. - @@ -145,16 +145,16 @@ Initializes a new instance of the class with an empty message string and the root cause of the exception. - . This constructor sets the properties of the Exception object as shown in the following table. - -|Property|Value| -|--------------|-----------| -||`null`| -||The empty string ("").| - + . This constructor sets the properties of the Exception object as shown in the following table. + +|Property|Value| +|--------------|-----------| +||`null`| +||The empty string ("").| + ]]> @@ -205,16 +205,16 @@ A describing the reason this exception was thrown. Initializes a new instance of the class with its message string set to the given message and the root cause exception. - . This constructor sets the properties of the `Exception` object as shown in the following table. - -|Property|Value| -|--------------|-----------| -||`null`| -||The message string.| - + . This constructor sets the properties of the `Exception` object as shown in the following table. + +|Property|Value| +|--------------|-----------| +||`null`| +||The message string.| + ]]> @@ -267,18 +267,18 @@ The exception that is the cause of the current exception. If the parameter is not , the current exception is raised in a block that handles the inner exception. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. - property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. - - The following table shows the initial property values for an instance of . - -|Property|Value| -|--------------|-----------| -||The inner exception reference.| -||The error message string.| - + property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. + + The following table shows the initial property values for an instance of . + +|Property|Value| +|--------------|-----------| +||The inner exception reference.| +||The error message string.| + ]]> diff --git a/xml/System.Runtime.Caching/ChangeMonitor.xml b/xml/System.Runtime.Caching/ChangeMonitor.xml index 9b5bb88cbdb..25d55c3f075 100644 --- a/xml/System.Runtime.Caching/ChangeMonitor.xml +++ b/xml/System.Runtime.Caching/ChangeMonitor.xml @@ -24,12 +24,12 @@ - Provides a base class for a derived custom type that monitors changes in the state of the data which a cache item depends on. + Provides a base class for a derived custom type that monitors changes in the state of the data that a cache item depends on. class is used as the base class for derived monitor classes that are specialized for particular cache implementations. A instance monitors changes in the state of data which a cache item depends on. For example, the item can be a file or data entity whose contents are cached. If the file or data entity is updated, the associated cache entry must be changed also. Common items that can be monitored include data entities (such as database fields, values, rows, or tables), another cache entry, and files and file attributes. + The class is used as the base class for derived monitor classes that are specialized for particular cache implementations. A instance monitors changes in the state of data that a cache item depends on. For example, the item can be a file or data entity whose contents are cached. If the file or data entity is updated, the associated cache entry must be changed also. Common items that can be monitored include data entities (such as database fields, values, rows, or tables), another cache entry, and files and file attributes. A dependency change is a change in the state of a dependency. In a typical cache implementation, after a instance notifies the cache that a dependency has changed, the cache performs the required action, such as invalidating the inserted cache entry. diff --git a/xml/System.Runtime.CompilerServices/CallSiteBinder.xml b/xml/System.Runtime.CompilerServices/CallSiteBinder.xml index 334aeeb1576..d531ae3dd9d 100644 --- a/xml/System.Runtime.CompilerServices/CallSiteBinder.xml +++ b/xml/System.Runtime.CompilerServices/CallSiteBinder.xml @@ -214,7 +214,7 @@ The CallSite the bind is being performed for. The arguments for the binder. Provides low-level runtime binding support. Classes can override this and provide a direct delegate for the implementation of rule. This can enable saving rules to disk, having specialized rules available at runtime, or providing a different caching policy. - A new delegate which replaces the CallSite Target. + A new delegate that replaces the CallSite Target. To be added. diff --git a/xml/System.Runtime.CompilerServices/MethodImplAttribute.xml b/xml/System.Runtime.CompilerServices/MethodImplAttribute.xml index cb73eef1d8b..b1b8925d55a 100644 --- a/xml/System.Runtime.CompilerServices/MethodImplAttribute.xml +++ b/xml/System.Runtime.CompilerServices/MethodImplAttribute.xml @@ -173,7 +173,7 @@ - A bitmask representing the desired value which specifies properties of the attributed method. + A bitmask representing the desired value, which specifies properties of the attributed method. Initializes a new instance of the class with the specified value. To be added. diff --git a/xml/System.Runtime.CompilerServices/StrongBox`1.xml b/xml/System.Runtime.CompilerServices/StrongBox`1.xml index db1c8f424ee..9d81f8cab40 100644 --- a/xml/System.Runtime.CompilerServices/StrongBox`1.xml +++ b/xml/System.Runtime.CompilerServices/StrongBox`1.xml @@ -64,11 +64,11 @@ The type of the value that the references. Holds a reference to a value. - @@ -114,7 +114,7 @@ - Initializes a new StrongBox which can receive a value when used in a reference call. + Initializes a new StrongBox that can receive a value when used in a reference call. To be added. diff --git a/xml/System.Runtime.DurableInstancing/InstanceLockedException.xml b/xml/System.Runtime.DurableInstancing/InstanceLockedException.xml index 189b3393925..258ba537e02 100644 --- a/xml/System.Runtime.DurableInstancing/InstanceLockedException.xml +++ b/xml/System.Runtime.DurableInstancing/InstanceLockedException.xml @@ -133,11 +133,11 @@ The exception that caused the current exception. Initializes an instance of the class by using the error message and the inner exception information passed as parameters. - property. - + property. + ]]> @@ -371,7 +371,7 @@ Gets the GUID associated with the current instance owner (who currently has a lock on the instance). - The GUID associated with the current instance owner. Returns Guid.Empty if the current instance owner is not known. + The GUID associated with the current instance owner. Returns Guid.Empty if the current instance owner is not known. To be added. @@ -397,7 +397,7 @@ System.Collections.Generic.IDictionary<System.Xml.Linq.XName,System.Object> - Gets serializable metadata information about the current instance owner (who currently has a lock on the instance). When present, this consists of the subset of instance owner metadata which is serializable. The metadata may contain information such as the location of the instance owner, who currently owns the lock. + Gets serializable metadata information about the current instance owner (who currently has a lock on the instance). When present, this consists of the subset of instance owner metadata that is serializable. The metadata may contain information such as the location of the instance owner, who currently owns the lock. The serializable metadata information about the current instance owner (who currently has a lock on the instance). To be added. diff --git a/xml/System.Runtime.DurableInstancing/InstancePersistenceContext.xml b/xml/System.Runtime.DurableInstancing/InstancePersistenceContext.xml index 25a3fde7341..2eb307ab602 100644 --- a/xml/System.Runtime.DurableInstancing/InstancePersistenceContext.xml +++ b/xml/System.Runtime.DurableInstancing/InstancePersistenceContext.xml @@ -16,11 +16,11 @@ Represents execution state information while a persistence command is being executed. - @@ -47,11 +47,11 @@ The instance key identifier for the key that has been associated. Must not be Guid.Empty. Indicates that the persistence provider has successfully associated a key to the current instance in the instance store. The identifier of the key is specified as a parameter. - @@ -85,15 +85,15 @@ Begin an asynchronous operation to bind an existing lock on an instance to the current instance handle. The version of the existing lock is passed as a parameter. The status of an asynchronous operation. - @@ -127,11 +127,11 @@ Begins executing a persistence command asynchronously. The status of an asynchronous operation. - @@ -158,13 +158,13 @@ Version of the lock acquired on the instance, or zero if the persistence provider does not implement lock versions. Binds a newly acquired lock on an instance to the current instance handle. The version of the acquired lock is passed as a parameter. - @@ -215,11 +215,11 @@ An instance identifier. Must not be Guid.Empty. Binds an instance whose identifier is specified as a parameter to the current instance handle. - @@ -248,11 +248,11 @@ The lock token of the instance owner. A persistence provider may choose to use the same value for the instance owner identifier and the owner's lock token. Binds an instance owner to the current instance handle. - @@ -281,15 +281,15 @@ The time-out value for the operation. Binds an existing lock on an instance to the current instance handle. The version of the existing lock is passed as a parameter. - @@ -313,11 +313,11 @@ Indicates that the persistence provider has successfully marked the current instance as complete in the instance store. - @@ -344,11 +344,11 @@ The instance key identifier for the key that has been completed. Must not be Guid.Empty. Indicates that the persistence provider has successfully marked a key as complete in the external store. The identifier of the key is specified as a parameter. - @@ -376,26 +376,26 @@ Creates an instance of an exception which can be thrown from TryCommand to trigger BindReclaimedLock behavior. An exception. - @@ -472,11 +472,11 @@ protected override bool TryCommand(InstancePersistenceContext context, InstanceP The time-out value for the operation. Executes a persistence command. - @@ -527,11 +527,11 @@ protected override bool TryCommand(InstancePersistenceContext context, InstanceP Gets the version of the lock held on the current instance by the current instance handle. The version of the instance lock bound to the current instance handle, or -1 if the handle isn't bound to a lock. - @@ -593,11 +593,11 @@ protected override bool TryCommand(InstancePersistenceContext context, InstanceP Completed instance metadata as a dictionary of instance identifier and instance key metadata, which is a dictionary of and objects. Indicates that the persistence provider has successfully retrieved the current instance from the instance store. - @@ -621,13 +621,13 @@ protected override bool TryCommand(InstancePersistenceContext context, InstanceP Gets the lock token of the instance owner bound to the current instance handle. The lock token bound to the current instance handle, or if the handle isn't bound to an instance owner. - @@ -654,11 +654,11 @@ protected override bool TryCommand(InstancePersistenceContext context, InstanceP Instance data as a dictionary of and objects. Indicates that the persistence provider has successfully persisted a set of instance data to the instance store. This has the effect of initializing the instance if it wasn't already. - @@ -714,11 +714,11 @@ protected override bool TryCommand(InstancePersistenceContext context, InstanceP if the metadata represents all of the metadata associated to the instance key; otherwise, . Indicates that the persistence provider has successfully read some instance key metadata for a key associated to the current instance from the instance store. - @@ -774,11 +774,11 @@ protected override bool TryCommand(InstancePersistenceContext context, InstanceP The value to specify whether the consistency to be set to or . Sets the instance owner metadata using the data passed in the parameter. - @@ -805,11 +805,11 @@ protected override bool TryCommand(InstancePersistenceContext context, InstanceP The reference to a function to be called. Sets the cancellation handler to be called when the cancel of an operation is requested. - @@ -836,11 +836,11 @@ protected override bool TryCommand(InstancePersistenceContext context, InstanceP The instance key identifier for the key that has been unassociated. Must not be Guid.Empty. Indicates that the persistence provider has successfully disassociated a key from the current instance in the instance store. The identifier of the key is specified as a parameter. - @@ -864,11 +864,11 @@ protected override bool TryCommand(InstancePersistenceContext context, InstanceP Gets the user context information attached to the current instance handle. The user context information. - @@ -899,11 +899,11 @@ protected override bool TryCommand(InstancePersistenceContext context, InstanceP The value of the metadata property. Indicates that the persistence provider has successfully written a metadata value for an instance key that is associated with the current instance to the instance store. - @@ -932,11 +932,11 @@ protected override bool TryCommand(InstancePersistenceContext context, InstanceP The value of the metadata property. Indicates that the persistence provider has successfully written a metadata value for the current instance to the external instance store. - @@ -965,11 +965,11 @@ protected override bool TryCommand(InstancePersistenceContext context, InstanceP The value of the metadata property. Indicates that the persistence provider has successfully written a metadata value for the current instance owner to the instance store. - diff --git a/xml/System.Runtime.InteropServices.ComTypes/ITypeInfo2.xml b/xml/System.Runtime.InteropServices.ComTypes/ITypeInfo2.xml index 550c130233a..3259709d496 100644 --- a/xml/System.Runtime.InteropServices.ComTypes/ITypeInfo2.xml +++ b/xml/System.Runtime.InteropServices.ComTypes/ITypeInfo2.xml @@ -66,11 +66,11 @@ Provides the managed definition of the interface. - @@ -128,11 +128,11 @@ When this method returns, contains a reference to the member. This parameter is passed uninitialized. Retrieves the addresses of static functions or variables, such as those defined in a DLL. - @@ -199,11 +199,11 @@ When this method returns, contains a reference to the created object. This parameter is passed uninitialized. Creates a new instance of a type that describes a component class (coclass). - @@ -304,11 +304,11 @@ A pointer to , which holds all custom data items. Gets all custom data from the specified function. - @@ -358,14 +358,14 @@ The index of the implementation type for the custom data. - A pointer to which holds all custom data items. + A pointer to that holds all custom data items. Gets all custom data for the specified implementation type. - @@ -523,11 +523,11 @@ When this method returns, contains a reference to the index of the type description within the containing type library. This parameter is passed uninitialized. Retrieves the type library that contains this type description and its index within that type library. - @@ -580,11 +580,11 @@ When this method returns, contains an that specifies where to put the retrieved data. This parameter is passed uninitialized. Gets the custom data. - @@ -646,11 +646,11 @@ If not , and the function is defined by an ordinal, then lpwOrdinal is set to point to the ordinal. Retrieves a description or specification of an entry point for a function in a DLL. - @@ -712,11 +712,11 @@ When this method returns, contains the fully qualified name of the Help file. This parameter is passed uninitialized. Retrieves the documentation string, the complete Help file name and path, and the context ID for the Help topic for a specified type description. - @@ -884,13 +884,13 @@ When this method returns, contains a reference to a structure that describes the specified function. This parameter is passed uninitialized. Retrieves the structure that contains information about a specified function. - method. - + method. + For more information, see [ITypeInfo::GetFuncDesc method](/windows/win32/api/oaidl/nf-oaidl-itypeinfo-getfuncdesc). - + ]]> @@ -1001,11 +1001,11 @@ When this method returns, contains a reference to an array in which name mappings are placed. This parameter is passed uninitialized. Maps between member names and member IDs, and parameter names and parameter IDs. - @@ -1060,11 +1060,11 @@ When this method returns, contains an that specifies where to put the retrieved data. This parameter is passed uninitialized. Gets the implementation type of the custom data. - @@ -1120,11 +1120,11 @@ When this method returns, contains a reference to the enumeration. This parameter is passed uninitialized. Retrieves the value for one implemented interface or base interface in a type description. - @@ -1181,11 +1181,11 @@ When this method returns, contains a reference to the string used in marshaling the fields of the structure described by the referenced type description, or returns if there is no information to return. This parameter is passed uninitialized. Retrieves marshaling information. - @@ -1246,11 +1246,11 @@ When this method returns, contains the number of names in the array. This parameter is passed uninitialized. Retrieves the variable with the specified member ID (or the name of the property or method and its parameters) that corresponds to the specified function ID. - @@ -1360,11 +1360,11 @@ When this method returns, contains the referenced type description. This parameter is passed uninitialized. Retrieves the referenced type descriptions, if a type description references other type descriptions. - @@ -1420,11 +1420,11 @@ When this method returns, contains a reference to a handle for the implemented interface. This parameter is passed uninitialized. Retrieves the type description of the implemented interface types, if a type description describes a COM class. - @@ -1478,13 +1478,13 @@ When this method returns, contains a reference to the structure that contains the attributes of this type description. This parameter is passed uninitialized. Retrieves a structure that contains the attributes of the type description. - method. - + method. + For more information, see [ITypeInfo::GetTypeAttr method](/windows/win32/api/oaidl/nf-oaidl-itypeinfo-gettypeattr). - + ]]> @@ -1538,11 +1538,11 @@ When this method returns, contains a reference to the of the containing type library. This parameter is passed uninitialized. Retrieves the interface for the type description, which enables a client compiler to bind to the type description's members. - @@ -1693,11 +1693,11 @@ When this method returns, contains an that specifies where to put the retrieved data. This parameter is passed uninitialized. Gets the variable for the custom data. - @@ -1753,13 +1753,13 @@ When this method returns, contains a reference to the structure that describes the specified variable. This parameter is passed uninitialized. Retrieves a structure that describes the specified variable. - method. - + method. + For more information, see [ITypeInfo::GetVarDesc method](/windows/win32/api/oaidl/nf-oaidl-itypeinfo-getvardesc). - + ]]> @@ -1875,22 +1875,22 @@ If returns , indicates the index of the argument with incorrect type. If more than one argument returns an error, indicates only the first argument with an error. Invokes a method, or accesses a property of an object, that implements the interface described by the type description. - method. - - Valid values for `wFlags` are: - -|Value|Description| -|-----------|-----------------| -|DISPATCH_METHOD|The member is accessed as a method. If there is ambiguity, both this flag and the `DISPATCH_PROPERTYGET` flag can be set.| -|DISPATCH_PROPERTYGET|The member is retrieved as a property or data member.| -|DISPATCH_PROPERTYPUT|The member is changed as a property or data member.| -|DISPATCH_PROPERTYPUTREF|The member is changed by using a reference assignment, rather than a value assignment. This value is valid only when the property accepts a reference to an object.| - + method. + + Valid values for `wFlags` are: + +|Value|Description| +|-----------|-----------------| +|DISPATCH_METHOD|The member is accessed as a method. If there is ambiguity, both this flag and the `DISPATCH_PROPERTYGET` flag can be set.| +|DISPATCH_PROPERTYGET|The member is retrieved as a property or data member.| +|DISPATCH_PROPERTYPUT|The member is changed as a property or data member.| +|DISPATCH_PROPERTYPUTREF|The member is changed by using a reference assignment, rather than a value assignment. This value is valid only when the property accepts a reference to an object.| + For more information, see [ITypeInfo::Invoke method](/windows/win32/api/oaidl/nf-oaidl-itypeinfo-invoke). - + ]]> @@ -1944,11 +1944,11 @@ A reference to the structure to release. Releases a structure previously returned by the method. - @@ -2002,11 +2002,11 @@ A reference to the structure to release. Releases a structure previously returned by the method. - @@ -2060,11 +2060,11 @@ A reference to the structure to release. Releases a structure previously returned by the method. - diff --git a/xml/System.Runtime.InteropServices.JavaScript/JSMarshalerArgument.xml b/xml/System.Runtime.InteropServices.JavaScript/JSMarshalerArgument.xml index e79c4cc9f78..bd983a2d56d 100644 --- a/xml/System.Runtime.InteropServices.JavaScript/JSMarshalerArgument.xml +++ b/xml/System.Runtime.InteropServices.JavaScript/JSMarshalerArgument.xml @@ -1253,7 +1253,7 @@ The type of the marshalled argument of the Action. The value to be marshalled. - The generated callback which marshals the argument of the Action. + The generated callback that marshals the argument of the Action. Marshals the specified value. This API supports JSImport infrastructure and is not intended to be used directly from your code. To be added. @@ -1301,7 +1301,7 @@ The type of marshalled result of the . The value to be marshalled. - The generated callback which marshals the result value of the . + The generated callback that marshals the result value of the . Marshals the specified value. This API supports JSImport infrastructure and is not intended to be used directly from your code. To be added. @@ -1349,7 +1349,7 @@ The type of marshalled result of the Func. The value to be marshalled. - The generated callback which marshals the result of the Func. + The generated callback that marshals the result of the Func. Marshals the specified value. This API supports JSImport infrastructure and is not intended to be used directly from your code. To be added. @@ -1407,8 +1407,8 @@ The type of the marshalled argument of the Func. The type of marshalled result of the Func. The value to be marshalled. - The generated callback which marshals the argument of the Func. - The generated callback which marshals the result of the Func. + The generated callback that marshals the argument of the Func. + The generated callback that marshals the result of the Func. Marshals the specified value. This API supports JSImport infrastructure and is not intended to be used directly from your code. To be added. @@ -1466,8 +1466,8 @@ The type of the marshalled argument of the Action. The type of the marshalled argument of the Action. The value to be marshalled. - The generated callback which marshals the argument of the Action. - The generated callback which marshals the argument of the Action. + The generated callback that marshals the argument of the Action. + The generated callback that marshals the argument of the Action. Marshals the specified value. This API supports JSImport infrastructure and is not intended to be used directly from your code. To be added. @@ -1535,9 +1535,9 @@ The type of the marshalled argument of the Action. The type of the marshalled argument of the Action. The value to be marshalled. - The generated callback which marshals the argument of the Action. - The generated callback which marshals the argument of the Action. - The generated callback which marshals the argument of the Action. + The generated callback that marshals the argument of the Action. + The generated callback that marshals the argument of the Action. + The generated callback that marshals the argument of the Action. Marshals the specified value. This API supports JSImport infrastructure and is not intended to be used directly from your code. To be added. @@ -1605,9 +1605,9 @@ The type of the marshalled argument of the Func. The type of marshalled result of the Func. The value to be marshalled. - The generated callback which marshals the argument of the Func. - The generated callback which marshals the argument of the Func. - The generated callback which marshals the result of the Func. + The generated callback that marshals the argument of the Func. + The generated callback that marshals the argument of the Func. + The generated callback that marshals the result of the Func. Marshals the specified value. This API supports JSImport infrastructure and is not intended to be used directly from your code. To be added. @@ -1685,10 +1685,10 @@ The type of the marshalled argument of the Func. The type of marshalled result of the Func. The value to be marshalled. - The generated callback which marshals the argument of the Func. - The generated callback which marshals the argument of the Func. - The generated callback which marshals the argument of the Func. - The generated callback which marshals the result of the Func. + The generated callback that marshals the argument of the Func. + The generated callback that marshals the argument of the Func. + The generated callback that marshals the argument of the Func. + The generated callback that marshals the result of the Func. Marshals the specified value. This API supports JSImport infrastructure and is not intended to be used directly from your code. To be added. @@ -2939,7 +2939,7 @@ The type of the marshalled argument of the Action. The value to be marshalled. - The generated callback which marshals the argument of the Action. + The generated callback that marshals the argument of the Action. Marshals the specified value. This API supports JSImport infrastructure and is not intended to be used directly from your code. To be added. @@ -2987,7 +2987,7 @@ The type of marshalled result of the . The value to be marshalled. - The generated callback which marshals the result value of the . + The generated callback that marshals the result value of the . Marshals the specified value. This API supports JSImport infrastructure and is not intended to be used directly from your code. To be added. @@ -3035,7 +3035,7 @@ The type of marshalled result of the Func. The value to be marshalled. - The generated callback which marshals the result of the Func. + The generated callback that marshals the result of the Func. Marshals the specified value. This API supports JSImport infrastructure and is not intended to be used directly from your code. To be added. @@ -3093,8 +3093,8 @@ The type of the marshalled argument of the Func. The type of marshalled result of the Func. The value to be marshalled. - The generated callback which marshals the argument of the Func. - The generated callback which marshals the result of the Func. + The generated callback that marshals the argument of the Func. + The generated callback that marshals the result of the Func. Marshals the specified value. This API supports JSImport infrastructure and is not intended to be used directly from your code. To be added. @@ -3152,8 +3152,8 @@ The type of the marshalled argument of the Action. The type of the marshalled argument of the Action. The value to be marshalled. - The generated callback which marshals the argument of the Action. - The generated callback which marshals the argument of the Action. + The generated callback that marshals the argument of the Action. + The generated callback that marshals the argument of the Action. Marshals the specified value. This API supports JSImport infrastructure and is not intended to be used directly from your code. To be added. @@ -3221,9 +3221,9 @@ The type of the marshalled argument of the Action. The type of the marshalled argument of the Action. The value to be marshalled. - The generated callback which marshals the argument of the Action. - The generated callback which marshals the argument of the Action. - The generated callback which marshals the argument of the Action. + The generated callback that marshals the argument of the Action. + The generated callback that marshals the argument of the Action. + The generated callback that marshals the argument of the Action. Marshals the specified value. This API supports JSImport infrastructure and is not intended to be used directly from your code. To be added. @@ -3291,9 +3291,9 @@ The type of the marshalled argument of the Func. The type of marshalled result of the Func. The value to be marshalled. - The generated callback which marshals the argument of the Func. - The generated callback which marshals the argument of the Func. - The generated callback which marshals the result of the Func. + The generated callback that marshals the argument of the Func. + The generated callback that marshals the argument of the Func. + The generated callback that marshals the result of the Func. Marshals the specified value. This API supports JSImport infrastructure and is not intended to be used directly from your code. To be added. @@ -3371,10 +3371,10 @@ The type of the marshalled argument of the Func. The type of marshalled result of the Func. The value to be marshalled. - The generated callback which marshals the argument of the Func. - The generated callback which marshals the argument of the Func. - The generated callback which marshals the argument of the Func. - The generated callback which marshals the result of the Func. + The generated callback that marshals the argument of the Func. + The generated callback that marshals the argument of the Func. + The generated callback that marshals the argument of the Func. + The generated callback that marshals the result of the Func. Marshals the specified value. This API supports JSImport infrastructure and is not intended to be used directly from your code. To be added. diff --git a/xml/System.Runtime.InteropServices/ExternalException.xml b/xml/System.Runtime.InteropServices/ExternalException.xml index 7226447b343..b8387f86d85 100644 --- a/xml/System.Runtime.InteropServices/ExternalException.xml +++ b/xml/System.Runtime.InteropServices/ExternalException.xml @@ -59,17 +59,17 @@ The base exception type for all COM interop exceptions and structured exception handling (SEH) exceptions. - property stores an integer value (HRESULT) that identifies the error. User defined exceptions should never derive from `ExternalException`, and an `ExternalException` should never be thrown by user code. Use the specific exceptions that derive from `ExternalException` instead. - - `ExternalException` uses the HRESULT E_FAIL which has the value 0x80004005. - - `ExternalException` uses the default implementation, which supports reference equality. - - For a list of initial values for an instance of `ExternalException`, see the `ExternalException` constructors. - + property stores an integer value (HRESULT) that identifies the error. User defined exceptions should never derive from `ExternalException`, and an `ExternalException` should never be thrown by user code. Use the specific exceptions that derive from `ExternalException` instead. + + `ExternalException` uses the HRESULT E_FAIL, which has the value 0x80004005. + + `ExternalException` uses the default implementation, which supports reference equality. + + For a list of initial values for an instance of `ExternalException`, see the `ExternalException` constructors. + ]]> @@ -121,16 +121,16 @@ Initializes a new instance of the class with default properties. - |A null reference (`Nothing` in Visual Basic).| -||A localized error message string.| - + |A null reference (`Nothing` in Visual Basic).| +||A localized error message string.| + ]]> @@ -175,16 +175,16 @@ The error message that specifies the reason for the exception. Initializes a new instance of the class with a specified error message. - |A null reference (`Nothing` in Visual Basic).| -||The error message string.| - + |A null reference (`Nothing` in Visual Basic).| +||The error message string.| + ]]> @@ -244,11 +244,11 @@ The contextual information about the source or destination. Initializes a new instance of the class from serialization data. - @@ -297,18 +297,18 @@ The exception that is the cause of the current exception. If the parameter is not , the current exception is raised in a block that handles the inner exception. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. - property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. - - The following table shows the initial property values for an instance of . - -|Property|Value| -|--------------|-----------| -||The inner exception reference.| -||The error message string.| - + property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. + + The following table shows the initial property values for an instance of . + +|Property|Value| +|--------------|-----------| +||The inner exception reference.| +||The error message string.| + ]]> @@ -357,17 +357,17 @@ The HRESULT of the error. Initializes a new instance of the class with a specified error message and the HRESULT of the error. - |The HRESULT of the error.| -||A null reference (`Nothing` in Visual Basic).| -||The error message string.| - + |The HRESULT of the error.| +||A null reference (`Nothing` in Visual Basic).| +||The error message string.| + ]]> @@ -411,11 +411,11 @@ Gets the of the error. The of the error. - diff --git a/xml/System.Runtime.InteropServices/InvalidComObjectException.xml b/xml/System.Runtime.InteropServices/InvalidComObjectException.xml index 68f06d8b7c0..64daed5fbba 100644 --- a/xml/System.Runtime.InteropServices/InvalidComObjectException.xml +++ b/xml/System.Runtime.InteropServices/InvalidComObjectException.xml @@ -77,7 +77,7 @@ ## Remarks An `InvalidComObjectException` is thrown when an invalid COM object is used. This happens when the `__ComObject` type is used directly, without having a backing class factory. For more information, see . - `InvalidComObjectException` uses the HRESULT COR_E_INVALIDCOMOBJECT which has the value 0x80131527. + `InvalidComObjectException` uses the HRESULT COR_E_INVALIDCOMOBJECT, which has the value 0x80131527. ]]> diff --git a/xml/System.Runtime.InteropServices/InvalidOleVariantTypeException.xml b/xml/System.Runtime.InteropServices/InvalidOleVariantTypeException.xml index c08ddcc56c6..277365e1c7e 100644 --- a/xml/System.Runtime.InteropServices/InvalidOleVariantTypeException.xml +++ b/xml/System.Runtime.InteropServices/InvalidOleVariantTypeException.xml @@ -75,7 +75,7 @@ diff --git a/xml/System.Runtime.InteropServices/MarshalDirectiveException.xml b/xml/System.Runtime.InteropServices/MarshalDirectiveException.xml index a067231abb6..98e58118d9e 100644 --- a/xml/System.Runtime.InteropServices/MarshalDirectiveException.xml +++ b/xml/System.Runtime.InteropServices/MarshalDirectiveException.xml @@ -75,7 +75,7 @@ diff --git a/xml/System.Runtime.InteropServices/SafeArrayRankMismatchException.xml b/xml/System.Runtime.InteropServices/SafeArrayRankMismatchException.xml index e7c9748f4b2..f723cc62cba 100644 --- a/xml/System.Runtime.InteropServices/SafeArrayRankMismatchException.xml +++ b/xml/System.Runtime.InteropServices/SafeArrayRankMismatchException.xml @@ -75,7 +75,7 @@ diff --git a/xml/System.Runtime.InteropServices/UCOMIStream.xml b/xml/System.Runtime.InteropServices/UCOMIStream.xml index d5730dc8ba2..0d8ece987ea 100644 --- a/xml/System.Runtime.InteropServices/UCOMIStream.xml +++ b/xml/System.Runtime.InteropServices/UCOMIStream.xml @@ -30,11 +30,11 @@ Use instead. - @@ -63,11 +63,11 @@ On successful return, contains the new stream object. Creates a new stream object with its own seek pointer that references the same bytes as the original stream. - @@ -96,11 +96,11 @@ Controls how the changes for the stream object are committed. Ensures that any changes made to a stream object open in transacted mode are reflected in the parent storage. - @@ -135,11 +135,11 @@ On successful return, contains the actual number of bytes written to the destination. Copies a specified number of bytes from the current seek pointer in the stream to the current seek pointer in another stream. - @@ -172,11 +172,11 @@ The requested restrictions on accessing the range. Restricts access to a specified range of bytes in the stream. - @@ -209,11 +209,11 @@ Pointer to a variable that receives the actual number of bytes read from the stream object. Reads a specified number of bytes from the stream object into memory starting at the current seek pointer. - @@ -239,11 +239,11 @@ Discards all changes that have been made to a transacted stream since the last call. - @@ -276,11 +276,11 @@ On successful return, contains the offset of the seek pointer from the beginning of the stream. Changes the seek pointer to a new location relative to the beginning of the stream, to the end of the stream, or to the current seek pointer. - @@ -309,11 +309,11 @@ Specifies the new size of the stream as a number of bytes. Changes the size of the stream object. - @@ -340,15 +340,15 @@ - On successful return, contains a structure which describes this stream object. + On successful return, contains a structure that describes this stream object. Specifies some of the members in the structure that this method does not return, thus saving some memory allocation operations. Retrieves the structure for this stream. - @@ -381,11 +381,11 @@ The access restrictions previously placed on the range. Removes the access restriction on a range of bytes previously restricted with . - @@ -418,11 +418,11 @@ On successful return, contains the actual number of bytes written to the stream object. The caller can set this pointer to , in which case this method does not provide the actual number of bytes written. Writes a specified number of bytes into the stream object starting at the current seek pointer. - diff --git a/xml/System.Runtime.Intrinsics/Vector128.xml b/xml/System.Runtime.Intrinsics/Vector128.xml index cb689d58c8a..5d0bc0e0da1 100644 --- a/xml/System.Runtime.Intrinsics/Vector128.xml +++ b/xml/System.Runtime.Intrinsics/Vector128.xml @@ -2437,7 +2437,7 @@ The type of the elements in the vector. The vector to be copied. The array to which is copied. - The starting index of which will be copied to. + The starting index of to which will be copied. Copies a to a given array starting at the specified index. To be added. The length of is less than . diff --git a/xml/System.Runtime.Intrinsics/Vector256.xml b/xml/System.Runtime.Intrinsics/Vector256.xml index 4c81b39f5ad..b2c688e632a 100644 --- a/xml/System.Runtime.Intrinsics/Vector256.xml +++ b/xml/System.Runtime.Intrinsics/Vector256.xml @@ -2199,7 +2199,7 @@ The type of the elements in the vector. The vector to be copied. The array to which is copied. - The starting index of which will be copied to. + The starting index of to which will be copied. Copies a to a given array starting at the specified index. To be added. The length of is less than . diff --git a/xml/System.Runtime.Intrinsics/Vector512.xml b/xml/System.Runtime.Intrinsics/Vector512.xml index 723ad31d581..ac8864951b1 100644 --- a/xml/System.Runtime.Intrinsics/Vector512.xml +++ b/xml/System.Runtime.Intrinsics/Vector512.xml @@ -1970,7 +1970,7 @@ The type of the elements in the vector. The vector to be copied. The array to which is copied. - The starting index of which will be copied to. + The starting index of to which will be copied. Copies a to a given array starting at the specified index. To be added. The length of is less than . diff --git a/xml/System.Runtime.Intrinsics/Vector64.xml b/xml/System.Runtime.Intrinsics/Vector64.xml index 559dc771b09..04aef99fe1f 100644 --- a/xml/System.Runtime.Intrinsics/Vector64.xml +++ b/xml/System.Runtime.Intrinsics/Vector64.xml @@ -2091,7 +2091,7 @@ The type of the elements in the vector. The vector to be copied. The array to which is copied. - The starting index of which will be copied to. + The starting index of to which will be copied. Copies a to a given array starting at the specified index. To be added. The length of is less than . @@ -4749,7 +4749,7 @@ On x86, this method corresponds to __m64 _mm_setr_pi8 ( * ) + , rounded as one ternary operation. This computes ( * ) as if to infinite precision, adds to that result as if to infinite precision, and finally rounds to the nearest representable value. - This differs from the non-fused sequence which would compute ( * ) as if to infinite precision, round the result to the nearest representable value, add to the rounded result as if to infinite precision, and finally round to the nearest representable value. + This differs from the non-fused sequence, which would compute ( * ) as if to infinite precision, round the result to the nearest representable value, add to the rounded result as if to infinite precision, and finally round to the nearest representable value. @@ -4782,7 +4782,7 @@ On x86, this method corresponds to __m64 _mm_setr_pi8 ( * ) + , rounded as one ternary operation. This computes ( * ) as if to infinite precision, adds to that result as if to infinite precision, and finally rounds to the nearest representable value. - This differs from the non-fused sequence which would compute ( * ) as if to infinite precision, round the result to the nearest representable value, add to the rounded result as if to infinite precision, and finally round to the nearest representable value. + This differs from the non-fused sequence, would compute ( * ) as if to infinite precision, round the result to the nearest representable value, add to the rounded result as if to infinite precision, and finally round to the nearest representable value. diff --git a/xml/System.Runtime.Loader/AssemblyLoadContext+ContextualReflectionScope.xml b/xml/System.Runtime.Loader/AssemblyLoadContext+ContextualReflectionScope.xml index 24a89c54242..5e23e20601c 100644 --- a/xml/System.Runtime.Loader/AssemblyLoadContext+ContextualReflectionScope.xml +++ b/xml/System.Runtime.Loader/AssemblyLoadContext+ContextualReflectionScope.xml @@ -37,7 +37,7 @@ ### Remarks -This is an implementation detail of the APIs. It is a struct, to avoid heap allocation. It is required to be public to avoid boxing. +This is an implementation detail of the APIs. It is a struct, to avoid heap allocation. It is required to be public to avoid boxing. ]]> @@ -70,7 +70,7 @@ This is an implementation detail of the - Sets to the value preceding the call to which returned this instance. + Sets to the value preceding the call to that returned this instance. To be added. diff --git a/xml/System.Runtime.Loader/AssemblyLoadContext.xml b/xml/System.Runtime.Loader/AssemblyLoadContext.xml index c848b271fc0..a716c585432 100644 --- a/xml/System.Runtime.Loader/AssemblyLoadContext.xml +++ b/xml/System.Runtime.Loader/AssemblyLoadContext.xml @@ -347,7 +347,7 @@ For more information, see [AssemblyLoadContext.CurrentContextualReflectionContex The assembly that is used to determine the requested instance. - Sets to the which loaded the assembly. + Sets to the that loaded the assembly. An object to restore the previous value of . It is intended to be used as an in a block. can load only: is not found. is not a valid assembly. - An assembly or module was loaded which did not match the . + An assembly or module was loaded that did not match the . Managed assembly loading algorithm diff --git a/xml/System.Runtime.Remoting.Messaging/AsyncResult.xml b/xml/System.Runtime.Remoting.Messaging/AsyncResult.xml index db9f70e4ac0..42eac0a56ce 100644 --- a/xml/System.Runtime.Remoting.Messaging/AsyncResult.xml +++ b/xml/System.Runtime.Remoting.Messaging/AsyncResult.xml @@ -32,29 +32,29 @@ Encapsulates the results of an asynchronous operation on a delegate. - class is used in conjunction with asynchronous method calls made using delegates. The returned from the delegate's `BeginInvoke` method can be cast to an . The has the property that holds the delegate object on which the asynchronous call was invoked. - - For more information about `BeginInvoke` and asynchronous calls using delegates, see [Asynchronous Programming Using Delegates](/dotnet/standard/asynchronous-programming-patterns/asynchronous-programming-using-delegates). - - - -## Examples - The following example demonstrates how to use the property to get a , and how to wait for an asynchronous call on a delegate. The is signaled when the asynchronous call completes, and you can wait for it by calling the method. - - The example consists of two classes, the class that contains the method which is called asynchronously, and the class that contains the `Main` method that makes the call. - - For more information and more examples of calling methods asynchronously by using delegates, see [Calling Synchronous Methods Asynchronously](/dotnet/standard/asynchronous-programming-patterns/calling-synchronous-methods-asynchronously). - + class is used in conjunction with asynchronous method calls made using delegates. The returned from the delegate's `BeginInvoke` method can be cast to an . The has the property that holds the delegate object on which the asynchronous call was invoked. + + For more information about `BeginInvoke` and asynchronous calls using delegates, see [Asynchronous Programming Using Delegates](/dotnet/standard/asynchronous-programming-patterns/asynchronous-programming-using-delegates). + + + +## Examples + The following example demonstrates how to use the property to get a , and how to wait for an asynchronous call on a delegate. The is signaled when the asynchronous call completes, and you can wait for it by calling the method. + + The example consists of two classes, the class that contains the method that's called asynchronously, and the class that contains the `Main` method that makes the call. + + For more information and more examples of calling methods asynchronously by using delegates, see [Calling Synchronous Methods Asynchronously](/dotnet/standard/asynchronous-programming-patterns/calling-synchronous-methods-asynchronously). + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/AsyncDelegateExamples/cpp/TestMethod.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System/IAsyncResult/Overview/TestMethod.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/TestMethod.vb" id="Snippet1"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/TestMethod.vb" id="Snippet1"::: :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/AsyncDelegateExamples/cpp/waithandle.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System/IAsyncResult/Overview/waithandle.cs" id="Snippet3"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/WaitHandle.vb" id="Snippet3"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/WaitHandle.vb" id="Snippet3"::: + ]]> Asynchronous Programming Using Delegates @@ -81,29 +81,29 @@ Gets the delegate object on which the asynchronous call was invoked. The delegate object on which the asynchronous call was invoked. - property can be cast to the actual class of the user-defined delegate. - - For example, if the delegate that was used to make the asynchronous call is of type `MyDelegate`, the delegate that is returned by this property must be cast to `MyDelegate`. The callback method can then call the delegate's `EndInvoke` method with the correct signature, in order to obtain the results of the asynchronous method call. - - - -## Examples - The following code example demonstrates how to use the property to get the delegate that was used to make the asynchronous call, in order to call `EndInvoke`. The example casts the , which is the only parameter of the callback method, to an object. - - The example consists of two classes, the class that contains the method which is called asynchronously, and the class that contains the `Main` method that makes the call. - - For more information on the way this callback example works, and more examples of calling methods asynchronously by using delegates, see [Calling Synchronous Methods Asynchronously](/dotnet/standard/asynchronous-programming-patterns/calling-synchronous-methods-asynchronously). - + property can be cast to the actual class of the user-defined delegate. + + For example, if the delegate that was used to make the asynchronous call is of type `MyDelegate`, the delegate that is returned by this property must be cast to `MyDelegate`. The callback method can then call the delegate's `EndInvoke` method with the correct signature, in order to obtain the results of the asynchronous method call. + + + +## Examples + The following code example demonstrates how to use the property to get the delegate that was used to make the asynchronous call, in order to call `EndInvoke`. The example casts the , which is the only parameter of the callback method, to an object. + + The example consists of two classes, the class that contains the method that's called asynchronously, and the class that contains the `Main` method that makes the call. + + For more information on the way this callback example works, and more examples of calling methods asynchronously by using delegates, see [Calling Synchronous Methods Asynchronously](/dotnet/standard/asynchronous-programming-patterns/calling-synchronous-methods-asynchronously). + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/AsyncDelegateExamples/cpp/TestMethod.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System/IAsyncResult/Overview/TestMethod.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/TestMethod.vb" id="Snippet1"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/TestMethod.vb" id="Snippet1"::: :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/AsyncDelegateExamples/cpp/callback.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System/IAsyncResult/Overview/callback.cs" id="Snippet5"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/callback.vb" id="Snippet5"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/callback.vb" id="Snippet5"::: + ]]> @@ -144,11 +144,11 @@ Implements the interface. No value is returned. - method of the interface is not relevant to the class. Implementation by throws a . Instead, obtain an by casting the interface returned by an asynchronous call made using a delegate. - + method of the interface is not relevant to the class. Implementation by throws a . Instead, obtain an by casting the interface returned by an asynchronous call made using a delegate. + ]]> @@ -177,27 +177,27 @@ Gets the object provided as the last parameter of a method call. The object provided as the last parameter of a method call. - property is used to pass information to a callback method. The last parameter of the `BeginInvoke` method call is a format string, which the callback method uses to format an output message. - - The example consists of two classes, the class that contains the method which is called asynchronously, and the class that contains the `Main` method that makes the call. - - For more information on the way this callback example works, and more examples of calling methods asynchronously by using delegates, see [Calling Synchronous Methods Asynchronously](/dotnet/standard/asynchronous-programming-patterns/calling-synchronous-methods-asynchronously). - + property is used to pass information to a callback method. The last parameter of the `BeginInvoke` method call is a format string, which the callback method uses to format an output message. + + The example consists of two classes, the class that contains the method that's called asynchronously, and the class that contains the `Main` method that makes the call. + + For more information on the way this callback example works, and more examples of calling methods asynchronously by using delegates, see [Calling Synchronous Methods Asynchronously](/dotnet/standard/asynchronous-programming-patterns/calling-synchronous-methods-asynchronously). + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/AsyncDelegateExamples/cpp/TestMethod.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System/IAsyncResult/Overview/TestMethod.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/TestMethod.vb" id="Snippet1"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/TestMethod.vb" id="Snippet1"::: :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/AsyncDelegateExamples/cpp/callback.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System/IAsyncResult/Overview/callback.cs" id="Snippet5"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/callback.vb" id="Snippet5"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/callback.vb" id="Snippet5"::: + ]]> @@ -226,32 +226,32 @@ Gets a that encapsulates Win32 synchronization handles, and allows the implementation of various synchronization schemes. A that encapsulates Win32 synchronization handles, and allows the implementation of various synchronization schemes. - returned by this method is automatically signaled when the asynchronous operation has completed. - - The wait handle is not closed automatically when you call `EndInvoke` on the delegate that was used to make the asynchronous method call. If you release all references to the wait handle, system resources are freed when garbage collection reclaims the wait handle. To free the system resources as soon as you are finished using the wait handle, call the method. Garbage collection works more efficiently when disposable objects are explicitly closed or disposed. - + returned by this method is automatically signaled when the asynchronous operation has completed. + + The wait handle is not closed automatically when you call `EndInvoke` on the delegate that was used to make the asynchronous method call. If you release all references to the wait handle, system resources are freed when garbage collection reclaims the wait handle. To free the system resources as soon as you are finished using the wait handle, call the method. Garbage collection works more efficiently when disposable objects are explicitly closed or disposed. + > [!CAUTION] -> The contained in the property can be used to block the current thread until the asynchronous call is complete. However the will ignore the , if one was specified during the `BeginInvoke` call. Therefore, a situation can occur where the application shuts down before the has finished executing, even if a is used to block until the asynchronous call completion. For an example of such a situation, see the example for the class, and remove the statement. - - - -## Examples - The following example demonstrates how to use the property to get a , and how to wait for an asynchronous call on a delegate. The is signaled when the asynchronous call completes, and you can wait for it by calling the method. - - The example consists of two classes, the class that contains the method which is called asynchronously, and the class that contains the `Main` method that makes the call. - - For more information and more examples of calling methods asynchronously by using delegates, see [Calling Synchronous Methods Asynchronously](/dotnet/standard/asynchronous-programming-patterns/calling-synchronous-methods-asynchronously). - +> The contained in the property can be used to block the current thread until the asynchronous call is complete. However the will ignore the , if one was specified during the `BeginInvoke` call. Therefore, a situation can occur where the application shuts down before the has finished executing, even if a is used to block until the asynchronous call completion. For an example of such a situation, see the example for the class, and remove the statement. + + + +## Examples + The following example demonstrates how to use the property to get a , and how to wait for an asynchronous call on a delegate. The is signaled when the asynchronous call completes, and you can wait for it by calling the method. + + The example consists of two classes, the class that contains the method that's called asynchronously, and the class that contains the `Main` method that makes the call. + + For more information and more examples of calling methods asynchronously by using delegates, see [Calling Synchronous Methods Asynchronously](/dotnet/standard/asynchronous-programming-patterns/calling-synchronous-methods-asynchronously). + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/AsyncDelegateExamples/cpp/TestMethod.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System/IAsyncResult/Overview/TestMethod.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/TestMethod.vb" id="Snippet1"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/TestMethod.vb" id="Snippet1"::: :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/AsyncDelegateExamples/cpp/waithandle.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System/IAsyncResult/Overview/waithandle.cs" id="Snippet3"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/WaitHandle.vb" id="Snippet3"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/WaitHandle.vb" id="Snippet3"::: + ]]> @@ -282,13 +282,13 @@ if the call completed synchronously; otherwise, . - delegate, it is probable that the thread that called BeginInvoke is the current thread. Most providers of the interface will not use the capability and will return a default `false`. - - Current implementation of always returns `false`. - + delegate, it is probable that the thread that called BeginInvoke is the current thread. Most providers of the interface will not use the capability and will return a default `false`. + + Current implementation of always returns `false`. + ]]> @@ -339,13 +339,13 @@ Gets the response message for the asynchronous call. A remoting message that should represent a response to a method call on a remote object. - method can return an object after the method is called. The return value can be cast to an . - - However, you do not need to call either of these methods directly. They are intended for use by the remoting infrastructure of the .NET Framework. - + method can return an object after the method is called. The return value can be cast to an . + + However, you do not need to call either of these methods directly. They are intended for use by the remoting infrastructure of the .NET Framework. + ]]> @@ -375,27 +375,27 @@ after the server has completed the call; otherwise, . - property to `true`. Thus, it is safe for the client to destroy the resources after the property returns `true`. - - - -## Examples - The following example shows how to use the property of the returned by `BeginInvoke` to discover when an asynchronous call completes. You might do this when making the asynchronous call from a thread that services the user interface. Polling for completion allows the calling thread to continue executing while the asynchronous call executes on a thread. - - The example consists of two classes, the class that contains the method which is called asynchronously, and the class that contains the `Main` method that makes the call. - - For more information and more examples of calling methods asynchronously by using delegates, see [Calling Synchronous Methods Asynchronously](/dotnet/standard/asynchronous-programming-patterns/calling-synchronous-methods-asynchronously). - + property to `true`. Thus, it is safe for the client to destroy the resources after the property returns `true`. + + + +## Examples + The following example shows how to use the property of the returned by `BeginInvoke` to discover when an asynchronous call completes. You might do this when making the asynchronous call from a thread that services the user interface. Polling for completion allows the calling thread to continue executing while the asynchronous call executes on a thread. + + The example consists of two classes, the class that contains the method that's called asynchronously, and the class that contains the `Main` method that makes the call. + + For more information and more examples of calling methods asynchronously by using delegates, see [Calling Synchronous Methods Asynchronously](/dotnet/standard/asynchronous-programming-patterns/calling-synchronous-methods-asynchronously). + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/AsyncDelegateExamples/cpp/TestMethod.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System/IAsyncResult/Overview/TestMethod.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/TestMethod.vb" id="Snippet1"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/TestMethod.vb" id="Snippet1"::: :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/AsyncDelegateExamples/cpp/polling.cpp" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System/IAsyncResult/Overview/polling.cs" id="Snippet4"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/polling.vb" id="Snippet4"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AsyncDelegateExamples/VB/polling.vb" id="Snippet4"::: + ]]> @@ -430,11 +430,11 @@ Gets the next message sink in the sink chain. An interface that represents the next message sink in the sink chain. - returns `null`. - + returns `null`. + ]]> @@ -463,11 +463,11 @@ The for the current remote method call. Sets an for the current remote method call, which provides a way to control asynchronous messages after they have been dispatched. - method. - + method. + ]]> @@ -506,15 +506,15 @@ Synchronously processes a response message returned by a method call on a remote object. Returns . - method implements the interface. You do not need to call this method directly. It is intended for use by the remoting infrastructure of the .NET Framework. - - invokes the consumer code's delegate. It also sets the instance returned by the method. If the `msg` parameter is of type , the same object is returned by . Otherwise, a reply message that contains a remoting exception is returned. - - also modifies the value returned by the property. - + method implements the interface. You do not need to call this method directly. It is intended for use by the remoting infrastructure of the .NET Framework. + + invokes the consumer code's delegate. It also sets the instance returned by the method. If the `msg` parameter is of type , the same object is returned by . Otherwise, a reply message that contains a remoting exception is returned. + + also modifies the value returned by the property. + ]]> diff --git a/xml/System.Runtime.Serialization/ISafeSerializationData.xml b/xml/System.Runtime.Serialization/ISafeSerializationData.xml index e9db78a7571..28c5900c889 100644 --- a/xml/System.Runtime.Serialization/ISafeSerializationData.xml +++ b/xml/System.Runtime.Serialization/ISafeSerializationData.xml @@ -46,13 +46,13 @@ Enables serialization of custom exception data in security-transparent code. - method. Starting with .NET Framework 4.0, that method is marked with the attribute which prevents execution in security-transparent code. To work around this condition, implement the interface and add custom data as shown in the example below. - + method. Starting with .NET Framework 4.0, that method is marked with the attribute, which prevents execution in security-transparent code. To work around this condition, implement the interface and add custom data as shown in the example below. + The method is called after serialization, and uses the to restore the custom data. - + ]]> @@ -98,11 +98,11 @@ An object that contains the state of the instance. This method is called when the instance is deserialized. - class. - + ]]> diff --git a/xml/System.Security.Claims/Claim.xml b/xml/System.Security.Claims/Claim.xml index e00267dc494..bf1e4051251 100644 --- a/xml/System.Security.Claims/Claim.xml +++ b/xml/System.Security.Claims/Claim.xml @@ -57,41 +57,41 @@ class.) On occasion, the collection of claims received from an issuer can be extended by subject attributes stored directly at the resource. A claim can be evaluated to determine access rights to data and other secured resources during the process of authorization and can also be used to make or express authentication decisions about a subject. - - Beginning with .NET 4.5, the Windows Identity Foundation (WIF) classes, which implement claims-based identity, have been fully integrated into the .NET Framework. The claims concept is implemented by the class. - - The following describes important properties of the class: - -- The property is a string (typically a URI) that contains the semantic information about the claim; it tells you what the value of the claim means. For example, a claim with a claim type of (`"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname"`) represents a user's first name. The value of the property can be one of the well-known claim types defined in the class, or it can be an arbitrary URI as defined by the issuer. For example, a claim type of "urn:spendinglimit" might represent a user attribute which makes sense within the business context of the issuer. - -- The property contains the value of the claim. In order to reduce dependencies and simplify administration, in WIF the value of a claim is represented only as a string. For more complex value types, it is recommended that you use standard XML schema types to indicate how the value is meant to be serialized into and deserialized from a string. - -- The property contains a string that identifies the type information for the value. This property should be used to understand the format of the value and to provide information about how to deserialize it. If your solution requires complex value types, it is recommended that you use standard XML schema types in the property to indicate how the property is meant to be serialized into and deserialized from a string. - -- The property is a object that represents the subject of the claim. The subject of the claim is the entity (typically the user who is requesting access to a resource) about which the claim is asserted. The contains, among its properties, a collection of claims that describe the properties and attributes of the subject as attested to by one or more issuers. - -- The property contains the name of the entity that issued the claim. The issuer of a claim is represented in WIF by a string that contains a name taken from a list of well-known issuers that is maintained by the issuer name registry. The issuer name registry is an instance of a class that derives from the class. The issuer name registry associates a mnemonic name to the cryptographic material needed to verify the signatures of tokens produced by the corresponding issuer. For example, the class, available out of the box with .NET 4.5, associates the mnemonic name for each issuer with its corresponding X.509 certificate. The list of well-known issuers is typically built at startup time by the issuer name registry. The list used by the is specified in the application configuration file. - -- The property contains the name of the entity that originally issued the claim. This property is designed to facilitate scenarios where a claim may pass through multiple issuers before it is presented by the client to the RP application; such as federation scenarios. You can examine the property to determine the entity that originally issued the claim. The name is taken from the list of well-known issuers maintained by the issuer name registry, as in the case of the property. - - - -## Examples - The following example extracts the claims associated to the authenticated user performing an HTTP request and writes them in the HTTP response. The current user is read from the as a and the claims are read from it. The claims are then written to the object. - -```csharp -ClaimsPrincipal principal = HttpContext.Current.User as ClaimsPrincipal; -if (null != principal) -{ - foreach (Claim claim in principal.Claims) - { - Response.Write("CLAIM TYPE: " + claim.Type + "; CLAIM VALUE: " + claim.Value + "
"); - } - -} - +## Remarks + A claim is a statement about a subject by an issuer. Claims represent attributes of the subject that are useful in the context of authentication and authorization operations. Subjects and issuers are both entities that are part of an identity scenario. Some typical examples of a subject are: a user, an application or service, a device, or a computer. Some typical examples of an issuer are: the operating system, an application, a service, a role provider, an identity provider, or a federation provider. An issuer delivers claims by issuing security tokens, typically through a Security Token Service (STS). On occasion, the collection of claims received from an issuer can be extended by subject attributes stored directly at the resource. A claim can be evaluated to determine access rights to data and other secured resources during the process of authorization and can also be used to make or express authentication decisions about a subject. + + Beginning with .NET Framework 4.5, the Windows Identity Foundation (WIF) classes, which implement claims-based identity, have been fully integrated into .NET Framework. The claims concept is implemented by the class. + + The following describes important properties of the class: + +- The property is a string (typically a URI) that contains the semantic information about the claim; it tells you what the value of the claim means. For example, a claim with a claim type of (`"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname"`) represents a user's first name. The value of the property can be one of the well-known claim types defined in the class, or it can be an arbitrary URI as defined by the issuer. For example, a claim type of "urn:spendinglimit" might represent a user attribute that makes sense within the business context of the issuer. + +- The property contains the value of the claim. In order to reduce dependencies and simplify administration, in WIF the value of a claim is represented only as a string. For more complex value types, it is recommended that you use standard XML schema types to indicate how the value is meant to be serialized into and deserialized from a string. + +- The property contains a string that identifies the type information for the value. This property should be used to understand the format of the value and to provide information about how to deserialize it. If your solution requires complex value types, it is recommended that you use standard XML schema types in the property to indicate how the property is meant to be serialized into and deserialized from a string. + +- The property is a object that represents the subject of the claim. The subject of the claim is the entity (typically the user who is requesting access to a resource) about which the claim is asserted. The contains, among its properties, a collection of claims that describe the properties and attributes of the subject as attested to by one or more issuers. + +- The property contains the name of the entity that issued the claim. The issuer of a claim is represented in WIF by a string that contains a name taken from a list of well-known issuers that is maintained by the issuer name registry. The issuer name registry is an instance of a class that derives from the class. The issuer name registry associates a mnemonic name to the cryptographic material needed to verify the signatures of tokens produced by the corresponding issuer. For example, the class, available out of the box with .NET 4.5, associates the mnemonic name for each issuer with its corresponding X.509 certificate. The list of well-known issuers is typically built at startup time by the issuer name registry. The list used by the is specified in the application configuration file. + +- The property contains the name of the entity that originally issued the claim. This property is designed to facilitate scenarios where a claim may pass through multiple issuers before it is presented by the client to the RP application; such as federation scenarios. You can examine the property to determine the entity that originally issued the claim. The name is taken from the list of well-known issuers maintained by the issuer name registry, as in the case of the property. + + + +## Examples + The following example extracts the claims associated to the authenticated user performing an HTTP request and writes them in the HTTP response. The current user is read from the as a and the claims are read from it. The claims are then written to the object. + +```csharp +ClaimsPrincipal principal = HttpContext.Current.User as ClaimsPrincipal; +if (null != principal) +{ + foreach (Claim claim in principal.Claims) + { + Response.Write("CLAIM TYPE: " + claim.Type + "; CLAIM VALUE: " + claim.Value + "
"); + } + +} + ``` ]]> @@ -152,7 +152,7 @@ if (null != principal) . ]]> @@ -366,7 +366,7 @@ if (null != principal) property is set to `null`. The and properties are set to . The property is set to ]]> @@ -430,7 +430,7 @@ if (null != principal) property is set to `null`. The and properties are set to . ]]> @@ -503,7 +503,7 @@ if (null != principal) property is set to `null`. The property is set according to the value of the `issuer` parameter. ]]> @@ -578,7 +578,7 @@ if (null != principal) property is set to `null`. ]]> @@ -712,7 +712,7 @@ if (null != principal) property of the new object is set to `null`. ]]> @@ -772,7 +772,7 @@ if (null != principal) property of the new object is set to the value of the `identity` parameter. ]]> @@ -827,7 +827,7 @@ if (null != principal) property is typically set when calling . ]]> @@ -875,7 +875,7 @@ if (null != principal) property is a name that is taken from a list of well-known issuers maintained by the issuer name registry. The issuer name registry is an instance of a class that derives from the class. The issuer name registry associates a mnemonic name (the issuer name) with the cryptographic material that is needed to verify signatures of tokens produced by the issuer; for example, an X.509 certificate. ]]> @@ -925,11 +925,11 @@ if (null != principal) property is a name that is taken from a list of well-known issuers maintained by the issuer name registry. The issuer name registry is an instance of a class that derives from the class. The issuer name registry associates a mnemonic name (the issuer name) with the cryptographic material that is needed to verify signatures of tokens produced by the issuer; for example, an X.509 certificate. - +## Remarks + Contains the name of the entity that originally issued the claim. This property is designed to facilitate scenarios where a claim may pass through multiple issuers before it is presented by the client to the RP application; such as federation scenarios. + + The value of the property is a name that is taken from a list of well-known issuers maintained by the issuer name registry. The issuer name registry is an instance of a class that derives from the class. The issuer name registry associates a mnemonic name (the issuer name) with the cryptographic material that is needed to verify signatures of tokens produced by the issuer; for example, an X.509 certificate. + Except for delegation and federation scenarios, the property and the property will usually have the same value. If the value of the property differs from the value of the property, the claim was first issued by the original issuer and was subsequently re-issued by the issuer. ]]> @@ -979,7 +979,7 @@ if (null != principal) property provides a dictionary of name-value pairs that allows metadata or other information about the claim to be associated with it. For claims generated from SAML tokens, this dictionary may contain keys given by the constants in the class. ]]> @@ -1035,7 +1035,7 @@ if (null != principal) , which contains a collection of claims that describe it. ]]> @@ -1084,7 +1084,7 @@ if (null != principal) and properties in the following format:."Type: Value". ]]> @@ -1132,7 +1132,7 @@ if (null != principal) property provides the semantic content of the claim, that is, it states what the claim is about. For example, a claim with a claim type of (`"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname"`) represents a user's first name. The claim type is typically a URI; however, you are not limited to any specific format other than that it must be representable as a string. The only general requirement is that the claim issuer and the claim consumer must agree about the meaning of the claim. Constants for the well-known claim types used by Windows Identity Foundation (WIF) are available through the class. The claim value is provided by the property. ]]> @@ -1180,9 +1180,9 @@ if (null != principal) property provides the underlying syntactic type information about the value. The property provides the semantic information about the value; that is, it provides the meaning of the value and tells a claim consumer how to interpret it. ]]> @@ -1232,7 +1232,7 @@ if (null != principal) property contains a string that identifies the type information of the value. This property can be used to understand the format of the value and to provide information about how to serialize and deserialize the value. If your solution requires complex value types, it is recommended that you use standard XML schema types in the property to indicate how the property is meant to be serialized and deserialized from a string. ]]> diff --git a/xml/System.Security.Cryptography.Pkcs/CmsSigner.xml b/xml/System.Security.Cryptography.Pkcs/CmsSigner.xml index 7b233498c40..63e775eba79 100644 --- a/xml/System.Security.Cryptography.Pkcs/CmsSigner.xml +++ b/xml/System.Security.Cryptography.Pkcs/CmsSigner.xml @@ -77,17 +77,17 @@ Initializes a new instance of the class with default values. - || -||2.16.840.1.101.3.4.2.1 (SHA-256)| -||| - + +|Property|Default value| +|--------------|-------------------| +||| +||2.16.840.1.101.3.4.2.1 (SHA-256)| +||| + ]]> @@ -137,17 +137,17 @@ The CSP parameters to describe which signing key to use. Initializes a new instance of the class from a persisted key. - || -||2.16.840.1.101.3.4.2.1 (SHA-256)| -||| - + +|Property|Default value| +|--------------|-------------------| +||| +||2.16.840.1.101.3.4.2.1 (SHA-256)| +||| + > [!IMPORTANT] > This method is only supported on .NET Framework. Its use on .NET Core throws a . @@ -187,16 +187,16 @@ The scheme to use for identifying which signing certificate was used. Initializes a new instance of the class with a specified subject identifier type. - |2.16.840.1.101.3.4.2.1 (SHA-256)| -|| if is ,

otherwise| - + +|Property|Default value| +|--------------|-------------------| +||2.16.840.1.101.3.4.2.1 (SHA-256)| +|| if is ,

otherwise| + ]]> @@ -233,19 +233,19 @@ The certificate whose private key will be used to sign a message. Initializes a new instance of the class with a specified signer certificate. - || -||2.16.840.1.101.3.4.2.1 (SHA-256)| -||| - - The signing certificate specified by the `certificate` parameter is not checked for validity on input. To validate the certificate prior to supplying it to this constructor, use the method. - + +|Property|Default value| +|--------------|-------------------| +||| +||2.16.840.1.101.3.4.2.1 (SHA-256)| +||| + + The signing certificate specified by the `certificate` parameter is not checked for validity on input. To validate the certificate prior to supplying it to this constructor, use the method. + ]]> @@ -284,18 +284,18 @@ The certificate whose private key will be used to sign a message. Initializes a new instance of the class with a specified signer certificate and subject identifier type. - |2.16.840.1.101.3.4.2.1 (SHA-256)| -|| if is ,

otherwise| - - The signing certificate specified by the `certificate` parameter is not checked for validity on input. To validate the certificate prior to supplying it to this constructor, use the method. - + +|Property|Default value| +|--------------|-------------------| +||2.16.840.1.101.3.4.2.1 (SHA-256)| +|| if is ,

otherwise| + + The signing certificate specified by the `certificate` parameter is not checked for validity on input. To validate the certificate prior to supplying it to this constructor, use the method. + ]]> @@ -334,18 +334,18 @@ The private key object to use when signing the message. Initializes a new instance of the class with a specified signer certificate, subject identifier type, and private key object. - |2.16.840.1.101.3.4.2.1 (SHA-256)| -|| if is ,

otherwise| - - The signing certificate specified by the `certificate` parameter is not checked for validity on input. To validate the certificate prior to supplying it to this constructor, use the method. - + +|Property|Default value| +|--------------|-------------------| +||2.16.840.1.101.3.4.2.1 (SHA-256)| +|| if is ,

otherwise| + + The signing certificate specified by the `certificate` parameter is not checked for validity on input. To validate the certificate prior to supplying it to this constructor, use the method. + This constructor does not validate that the `privateKey` parameter corresponds to the public key in `certificate`. If the keys don't match, the class and method throw a during the signing process. ]]> @@ -459,11 +459,11 @@ Gets a collection of certificates which are considered with and . A collection of certificates which are considered with and . - via when the indicates that more than one certificate should be included. Any certificate which is part of this collection that is not relevant to the value is ignored. - + via when the indicates that more than one certificate should be included. Any certificate that is part of this collection that is not relevant to the value is ignored. + ]]> @@ -507,11 +507,11 @@ Gets or sets the algorithm identifier for the hash algorithm to use with the signature. The algorithm identifier for the hash algorithm to use with the signature. - . - + . + ]]> @@ -647,13 +647,13 @@ Gets a collections of attributes to associate with this signature that are also protected by the signature. A collections of attributes to associate with this signature that are also protected by the signature. - collection retrieved by the property is the signing time attribute. - - A object and a object will be automatically generated and placed in the property for the corresponding signer whenever the property is not empty. - + collection retrieved by the property is the signing time attribute. + + A object and a object will be automatically generated and placed in the property for the corresponding signer whenever the property is not empty. + ]]> @@ -731,11 +731,11 @@ Gets a collections of attributes to associate with this signature that are not protected by the signature. A collections of attributes to associate with this signature that are not protected by the signature. - collection retrieved by the property is a countersignature. - + collection retrieved by the property is a countersignature. + ]]> diff --git a/xml/System.Security.Cryptography.Pkcs/Pkcs12Builder.xml b/xml/System.Security.Cryptography.Pkcs/Pkcs12Builder.xml index ea5ec51b5fe..f016a7a6c8c 100644 --- a/xml/System.Security.Cryptography.Pkcs/Pkcs12Builder.xml +++ b/xml/System.Security.Cryptography.Pkcs/Pkcs12Builder.xml @@ -518,7 +518,7 @@ ## Remarks This method exists for compatibility with the PKCS#12 specification, but its use is not recommended for purposes other than testing. - When building a PFX that can be used by the overloads of or which do not accept a password parameter, use the method with as the password. + When building a PFX that can be used by the overloads of or that do not accept a password parameter, use the method with as the password. ]]> diff --git a/xml/System.Security.Cryptography.Pkcs/Pkcs12CertBag.xml b/xml/System.Security.Cryptography.Pkcs/Pkcs12CertBag.xml index 992fa6a0671..dc2cc8d6031 100644 --- a/xml/System.Security.Cryptography.Pkcs/Pkcs12CertBag.xml +++ b/xml/System.Security.Cryptography.Pkcs/Pkcs12CertBag.xml @@ -62,7 +62,7 @@ - Gets the Object Identifier (OID) which identifies the content type of the encoded certificte value. - The Object Identifier (OID) which identifies the content type of the encoded certificate value. + Gets the Object Identifier (OID) that identifies the content type of the encoded certificte value. + The Object Identifier (OID) that identifies the content type of the encoded certificate value. class, via the and members. This type does not have special support for SDSI certificates, but callers expecting an SDSI certificate (or a certificate type defined after IETF RFC 7292) can process the value directly via the property. diff --git a/xml/System.Security.Cryptography.Pkcs/Pkcs12Info.xml b/xml/System.Security.Cryptography.Pkcs/Pkcs12Info.xml index a034782df53..2d297908b75 100644 --- a/xml/System.Security.Cryptography.Pkcs/Pkcs12Info.xml +++ b/xml/System.Security.Cryptography.Pkcs/Pkcs12Info.xml @@ -93,13 +93,13 @@ The data to interpret as a PKCS#12 PFX. - When this method returns, contains a value that indicates the number of bytes from which were read by this method. This parameter is treated as uninitialized. + When this method returns, contains a value that indicates the number of bytes from that were read by this method. This parameter is treated as uninitialized. to store without making a defensive copy; otherwise, . The default is . Reads the provided data as a PKCS#12 PFX and returns an object view of the contents. An object view of the PKCS#12 PFX decoded from the input. - The contents of the parameter were not successfully decoded as a PKCS#12 PFX. @@ -150,14 +150,14 @@ Attempts to verify the integrity of the contents with a password. - . + Therefore, there is no guarantee that a password that results in a `true` return from this method will succeed on a call to . ]]> @@ -194,9 +194,9 @@ if the password successfully verifies the integrity of the contents; if the password is not correct or the contents have been altered. - .Empty` represents the `null` password and `String.Empty.AsSpan()` represents the "empty" password. If one of those two values returns `true`, the other won't. @@ -239,9 +239,9 @@ if the password successfully verifies the integrity of the contents; if the password is not correct or the contents have been altered. - returns `false`, and vice versa. diff --git a/xml/System.Security.Cryptography.Pkcs/Pkcs12SafeContents.xml b/xml/System.Security.Cryptography.Pkcs/Pkcs12SafeContents.xml index 2b77bff6f3e..6887520f4dd 100644 --- a/xml/System.Security.Cryptography.Pkcs/Pkcs12SafeContents.xml +++ b/xml/System.Security.Cryptography.Pkcs/Pkcs12SafeContents.xml @@ -83,7 +83,7 @@ The certificate to add. Adds a certificate to the SafeContents via a new and returns the newly created bag instance. - The bag instance which was added to the SafeContents. + The bag instance that was added to the SafeContents. To be added. The parameter is . This instance is read-only. @@ -119,7 +119,7 @@ The asymmetric private key to add. Adds an asymmetric private key to the SafeContents via a new and returns the newly created bag instance. - The bag instance which was added to the SafeContents. + The bag instance that was added to the SafeContents. To be added. The parameter is . This instance is read-only. @@ -157,15 +157,15 @@ The nested contents to add to the SafeContents. Adds a nested SafeContents to the SafeContents via a new and returns the newly created bag instance. - The bag instance which was added to the SafeContents. + The bag instance that was added to the SafeContents. - The parameter is . @@ -202,11 +202,11 @@ The SafeBag value to add. Adds a SafeBag to the SafeContents. - The parameter is . @@ -247,10 +247,10 @@ - The Object Identifier (OID) which identifies the data type of the secret value. + The Object Identifier (OID) that identifies the data type of the secret value. The BER-encoded value representing the secret to add. Adds an ASN.1 BER-encoded value with a specified type identifier to the SafeContents via a new and returns the newly created bag instance. - The bag instance which was added to the SafeContents. + The bag instance that was added to the SafeContents. To be added. The parameter is . This instance is read-only. @@ -297,7 +297,7 @@ The bytes to use as a password when encrypting the key material. The password-based encryption (PBE) parameters to use when encrypting the key material. Adds an encrypted asymmetric private key to the SafeContents via a new from a byte-based password in an array and returns the newly created bag instance. - The bag instance which was added to the SafeContents. + The bag instance that was added to the SafeContents. To be added. The parameter is . This instance is read-only. @@ -346,7 +346,7 @@ The bytes to use as a password when encrypting the key material. The password-based encryption (PBE) parameters to use when encrypting the key material. Adds an encrypted asymmetric private key to the SafeContents via a new from a byte-based password in a span and returns the newly created bag instance. - The bag instance which was added to the SafeContents. + The bag instance that was added to the SafeContents. To be added. The parameter is . This instance is read-only. @@ -395,7 +395,7 @@ The password to use when encrypting the key material. The password-based encryption (PBE) parameters to use when encrypting the key material. Adds an encrypted asymmetric private key to the SafeContents via a new from a character-based password in a span and returns the newly created bag instance. - The bag instance which was added to the SafeContents. + The bag instance that was added to the SafeContents. To be added. The parameter is . This instance is read-only. @@ -445,7 +445,7 @@ The password to use when encrypting the key material. The password-based encryption (PBE) parameters to use when encrypting the key material. Adds an encrypted asymmetric private key to the SafeContents via a new from a character-based password in a string and returns the newly created bag instance. - The bag instance which was added to the SafeContents. + The bag instance that was added to the SafeContents. To be added. The parameter is . This instance is read-only. @@ -513,9 +513,9 @@ The bytes to use as a password for decrypting the encrypted contents. Decrypts the contents of this SafeContents value using a byte-based password from an array. - The bytes to use as a password for decrypting the encrypted contents. Decrypts the contents of this SafeContents value using a byte-based password from a span. - The password to use for decrypting the encrypted contents. Decrypts the contents of this SafeContents value using a character-based password from a span. - @@ -648,9 +648,9 @@ The contents were not successfully decrypted. The password to use for decrypting the encrypted contents. Decrypts the contents of this SafeContents value using a character-based password from a string. - @@ -721,9 +721,9 @@ The contents were not successfully decrypted. if this value is in a read-only state; otherwise, . The default value is . - is read-only when the value is created to represent previously encoded values, such as from or the encoding operation internal to . diff --git a/xml/System.Security.Cryptography.Pkcs/Pkcs12SecretBag.xml b/xml/System.Security.Cryptography.Pkcs/Pkcs12SecretBag.xml index e5cca49ce89..46b79099444 100644 --- a/xml/System.Security.Cryptography.Pkcs/Pkcs12SecretBag.xml +++ b/xml/System.Security.Cryptography.Pkcs/Pkcs12SecretBag.xml @@ -49,8 +49,8 @@ - Gets the Object Identifier (OID) which identifies the data type of the secret value. - The Object Identifier (OID) which identifies the data type of the secret value. + Gets the Object Identifier (OID) that identifies the data type of the secret value. + The Object Identifier (OID) that identifies the data type of the secret value. To be added. diff --git a/xml/System.Security.Cryptography.Pkcs/Rfc3161TimestampToken.xml b/xml/System.Security.Cryptography.Pkcs/Rfc3161TimestampToken.xml index 97175d9c0f5..b3b3ce10533 100644 --- a/xml/System.Security.Cryptography.Pkcs/Rfc3161TimestampToken.xml +++ b/xml/System.Security.Cryptography.Pkcs/Rfc3161TimestampToken.xml @@ -199,7 +199,7 @@ The value from calling The data to verify against this time-stamp token. - When this method returns, the certificate from the Timestamp Authority (TSA) which signed this token, or if a signer certificate cannot be determined. This parameter is treated as uninitialized. + When this method returns, the certificate from the Timestamp Authority (TSA) that signed this token, or if a signer certificate cannot be determined. This parameter is treated as uninitialized. An optional collection of certificates to consider as the Timestamp Authority (TSA) certificates, in addition to any certificates that may be included within the token. Verifies that the current token is a valid time-stamp token for the provided data. @@ -266,7 +266,7 @@ If the digest does not match, or the TSA certificate could not be determined, th The cryptographic hash to verify against this time-stamp token. The algorithm which produced . - When this method returns, the certificate from the Timestamp Authority (TSA) which signed this token, or if a signer certificate cannot be determined. This parameter is treated as uninitialized. + When this method returns, the certificate from the Timestamp Authority (TSA) that signed this token, or if a signer certificate cannot be determined. This parameter is treated as uninitialized. An optional collection of certificates to consider as the Timestamp Authority (TSA) certificates, in addition to any certificates that may be included within the token. Verifies that the current token is a valid time-stamp token for the provided data hash and algorithm identifier. @@ -340,7 +340,7 @@ If the digest does not match, the algorithm does not match, or the TSA certifica The cryptographic hash to verify against this time-stamp token. The OID of the hash algorithm. - When this method returns, the certificate from the Timestamp Authority (TSA) which signed this token, or if a signer certificate cannot be determined. This parameter is treated as uninitialized. + When this method returns, the certificate from the Timestamp Authority (TSA) that signed this token, or if a signer certificate cannot be determined. This parameter is treated as uninitialized. An optional collection of certificates to consider as the Timestamp Authority (TSA) certificates, in addition to any certificates that may be included within the token. Verifies that the current token is a valid time-stamp token for the provided data hash and algorithm identifier. diff --git a/xml/System.Security.Cryptography.X509Certificates/CertificateRequest.xml b/xml/System.Security.Cryptography.X509Certificates/CertificateRequest.xml index 968be46de02..3bdfae5ac92 100644 --- a/xml/System.Security.Cryptography.X509Certificates/CertificateRequest.xml +++ b/xml/System.Security.Cryptography.X509Certificates/CertificateRequest.xml @@ -1148,7 +1148,7 @@ This object was created with a constructor which did not accept a signing key. A bitwise combination of the enumeration values that specifies how to load the request. The RSA Signature Padding to use when creating a certificate from this request. For RSA signing certificates using the default signature generator, this parameter is required; otherwise, this parameter is ignored. Loads a binary PKCS#10 signing request as a new CertificateRequest instance. - A CertificateRequest instance which contains the information from the signing request. + A CertificateRequest instance that contains the information from the signing request. To be added. . is or . @@ -1215,7 +1215,7 @@ This object was created with a constructor which did not accept a signing key. A bitwise combination of the enumeration values that specifies how to load the request. The RSA Signature Padding to use when creating a certificate from this request. For RSA signing certificates using the default signature generator, this parameter is required; otherwise, this parameter is ignored. Loads a binary PKCS#10 signing request as a new CertificateRequest instance. - A CertificateRequest instance which contains the information from the signing request. + A CertificateRequest instance that contains the information from the signing request. To be added. . is or . @@ -1280,7 +1280,7 @@ This object was created with a constructor which did not accept a signing key. A bitwise combination of the enumeration values that specifies how to load the request. The RSA Signature Padding to use when creating a certificate from this request. For RSA signing certificates using the default signature generator, this parameter is required; otherwise, this parameter is ignored. Loads the first PEM-encoded PKCS#10 signing request from as a new CertificateRequest instance. - A CertificateRequest instance which contains the information from the signing request. + A CertificateRequest instance that contains the information from the signing request. To be added. . is or . @@ -1290,7 +1290,7 @@ This object was created with a constructor which did not accept a signing key. specifies a value that is not supported. does not contain a PKCS#10 signing request. - + -or- is not a valid PKCS#10 signing request. @@ -1343,7 +1343,7 @@ This object was created with a constructor which did not accept a signing key. A bitwise combination of the enumeration values that specifies how to load the request. The RSA Signature Padding to use when creating a certificate from this request. For RSA signing certificates using the default signature generator, this parameter is required; otherwise, this parameter is ignored. Loads the first PEM-encoded PKCS#10 signing request from as a new CertificateRequest instance. - A CertificateRequest instance which contains the information from the signing request. + A CertificateRequest instance that contains the information from the signing request. To be added. . is or . @@ -1353,7 +1353,7 @@ This object was created with a constructor which did not accept a signing key. specifies a value that is not supported. does not contain a PKCS#10 signing request. - + -or- is not a valid PKCS#10 signing request. diff --git a/xml/System.Security.Cryptography.Xml/CipherData.xml b/xml/System.Security.Cryptography.Xml/CipherData.xml index a1dea8c12a2..64bf1c53e24 100644 --- a/xml/System.Security.Cryptography.Xml/CipherData.xml +++ b/xml/System.Security.Cryptography.Xml/CipherData.xml @@ -38,25 +38,25 @@ Represents the element in XML encryption. This class cannot be inherited. - class represents the `` element in XML encryption. It is a required element that provides the encrypted data. It must either contain the encrypted data as base64-encoded text of the `` element, or provide a reference to an external location containing the encrypted data using the `` element. - - In many cases, you do not need to directly create a new instance of the class. The , , and classes create instances for you. - + class represents the `` element in XML encryption. It is a required element that provides the encrypted data. It must either contain the encrypted data as base64-encoded text of the `` element, or provide a reference to an external location containing the encrypted data using the `` element. + + In many cases, you do not need to directly create a new instance of the class. The , , and classes create instances for you. + > [!NOTE] -> A object can have either a property or a property, but not both. A is thrown if both are assigned to a object. - - - -## Examples - The following code example uses the class to create an `` element that contains a `` element, and then writes the XML to an XML file. - +> A object can have either a property or a property, but not both. A is thrown if both are assigned to a object. + + + +## Examples + The following code example uses the class to create an `` element that contains a `` element, and then writes the XML to an XML file. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/cpp/encrypteddata.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/CipherData/Overview/encrypteddata.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/VB/encrypteddata.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/VB/encrypteddata.vb" id="Snippet1"::: + ]]> @@ -97,20 +97,20 @@ Initializes a new instance of the class. - object that represents the `` element in XML encryption. The `` element is a required element in XML encryption. - - - -## Examples - The following code example shows how to create a new instance of the class. The entire sample can be found in the class topic. - + object that represents the `` element in XML encryption. The `` element is a required element in XML encryption. + + + +## Examples + The following code example shows how to create a new instance of the class. The entire sample can be found in the class topic. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/cpp/encrypteddata.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/CipherData/Overview/encrypteddata.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/VB/encrypteddata.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/VB/encrypteddata.vb" id="Snippet2"::: + ]]> @@ -146,23 +146,23 @@ The encrypted data to use for the element. Initializes a new instance of the class using a byte array as the value. - object that represents the `` element in XML encryption. The constructor assigns the `cipherValue` value to the property as the actual encrypted data. - + object that represents the `` element in XML encryption. The constructor assigns the `cipherValue` value to the property as the actual encrypted data. + > [!NOTE] -> The `` element can have either a or a child element, but not both. A is thrown if both are assigned to a object. - - - -## Examples - The following code example shows how to create a new instance of the class. - +> The `` element can have either a or a child element, but not both. A is thrown if both are assigned to a object. + + + +## Examples + The following code example shows how to create a new instance of the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/cryptography.Xml.EncryptedData2/CPP/encrypteddata.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/CipherData/.ctor/encrypteddata.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.EncryptedData2/VB/encrypteddata.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.EncryptedData2/VB/encrypteddata.vb" id="Snippet1"::: + ]]> The parameter is . @@ -200,23 +200,23 @@ The object to use. Initializes a new instance of the class using a object. - object that represents the `` element in XML encryption and assigns the `cipherReference` value to the property. The object represents the `` element, which provides the location of the encrypted data. - + object that represents the `` element in XML encryption and assigns the `cipherReference` value to the property. The object represents the `` element, which provides the location of the encrypted data. + > [!NOTE] -> A object can have either a property or a property, but not both. A is thrown if both are assigned to a object. - - - -## Examples - The following code example shows how to create a new instance of the class using information. - +> A object can have either a property or a property, but not both. A is thrown if both are assigned to a object. + + + +## Examples + The following code example shows how to create a new instance of the class using information. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/cryptography.Xml.CipherReference/CPP/example.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/CipherData/.ctor/example.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.CipherReference/VB/example.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.CipherReference/VB/example.vb" id="Snippet1"::: + ]]> The parameter is . @@ -255,23 +255,23 @@ Gets or sets the element. A object. - ` element identifies a source which, when processed, yields the encrypted data. For more information about this element, see . - + ` element identifies a source that, when processed, yields the encrypted data. For more information about this element, see . + > [!NOTE] -> A object can have either a property or a property, but not both. A is thrown if both are assigned to a object. - - - -## Examples - The following code example shows how to create a new instance of the class using information. - +> A object can have either a property or a property, but not both. A is thrown if both are assigned to a object. + + + +## Examples + The following code example shows how to create a new instance of the class using information. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/cryptography.Xml.CipherReference/CPP/example.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/CipherData/.ctor/example.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.CipherReference/VB/example.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.CipherReference/VB/example.vb" id="Snippet1"::: + ]]> The property was set to . @@ -310,23 +310,23 @@ Gets or sets the element. A byte array that represents the element. - [!NOTE] -> The `` element can have either a or a child element, but not both. A is thrown if both are assigned to a object. - - - -## Examples - The following code example shows how to create a new instance of the class. - +> The `` element can have either a or a child element, but not both. A is thrown if both are assigned to a object. + + + +## Examples + The following code example shows how to create a new instance of the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/cryptography.Xml.EncryptedData2/CPP/encrypteddata.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/CipherData/.ctor/encrypteddata.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.EncryptedData2/VB/encrypteddata.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.EncryptedData2/VB/encrypteddata.vb" id="Snippet1"::: + ]]> The property was set to . @@ -365,20 +365,20 @@ Gets the XML values for the object. A object that represents the XML information for the object. - object. - - - -## Examples - The following code example demonstrates how to create a new instance of the object. - + object. + + + +## Examples + The following code example demonstrates how to create a new instance of the object. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/cpp/encrypteddata.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/CipherData/Overview/encrypteddata.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/VB/encrypteddata.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/VB/encrypteddata.vb" id="Snippet2"::: + ]]> The property and the property are . @@ -428,11 +428,11 @@ An that represents the XML data to load. Loads XML data from an into a object. - method overwrites existing XML elements with the `value` parameter. - + method overwrites existing XML elements with the `value` parameter. + ]]> The parameter is . diff --git a/xml/System.Security.Cryptography.Xml/CipherReference.xml b/xml/System.Security.Cryptography.Xml/CipherReference.xml index 1f7c5928089..6d1def7537d 100644 --- a/xml/System.Security.Cryptography.Xml/CipherReference.xml +++ b/xml/System.Security.Cryptography.Xml/CipherReference.xml @@ -38,34 +38,34 @@ Represents the element in XML encryption. This class cannot be inherited. - ` element in XML encryption. It identifies a source which, when processed, yields the encrypted data. - - The actual encrypted data referenced by the `` is obtained by the following process. The ` URI` property contains a Uniform Resource Identifier (URI) that is dereferenced. If the `` element also contains a transform chain, the data resulting from dereferencing the URI is transformed as specified to produce the encrypted data. For example, if the encrypted data is base64-encoded within an XML document, the transforms would specify an XPath expression followed by a base64 decoding so the encrypted data can be extracted. - - The syntax of the URI and transforms is similar to that of XML digital signatures. However, in XML digital signatures, both generation and validation processing start with the same source data and perform that transform in the same order. In XML encryption, the decrypting application has only the encrypted data and the specified transforms. The transforms are enumerated in the order necessary to obtain the encrypted data. - - **Note** By default, you cannot dereference cipher references from documents with unknown sources, such as files from a Web site, because the property is **null**. For example, when you attempt to decrypt a file containing a `` element that references a file on the Web, a is thrown, even if the request is made by a fully trusted assembly. - - If you are sure the documents you are decrypting can be trusted, you can change this behavior for fully trusted applications by using the following code: - -``` -Evidence ev = new Evidence(); -ev.AddHost (new Zone(SecurityZone.MyComputer)); -EncryptedXml exml = new EncryptedXml(doc, ev); -``` - - - -## Examples - The following code example creates a new instance of . - + ` element in XML encryption. It identifies a source that, when processed, yields the encrypted data. + + The actual encrypted data referenced by the `` is obtained by the following process. The ` URI` property contains a Uniform Resource Identifier (URI) that is dereferenced. If the `` element also contains a transform chain, the data resulting from dereferencing the URI is transformed as specified to produce the encrypted data. For example, if the encrypted data is base64-encoded within an XML document, the transforms would specify an XPath expression followed by a base64 decoding so the encrypted data can be extracted. + + The syntax of the URI and transforms is similar to that of XML digital signatures. However, in XML digital signatures, both generation and validation processing start with the same source data and perform that transform in the same order. In XML encryption, the decrypting application has only the encrypted data and the specified transforms. The transforms are enumerated in the order necessary to obtain the encrypted data. + + **Note** By default, you cannot dereference cipher references from documents with unknown sources, such as files from a Web site, because the property is **null**. For example, when you attempt to decrypt a file containing a `` element that references a file on the Web, a is thrown, even if the request is made by a fully trusted assembly. + + If you are sure the documents you are decrypting can be trusted, you can change this behavior for fully trusted applications by using the following code: + +``` +Evidence ev = new Evidence(); +ev.AddHost (new Zone(SecurityZone.MyComputer)); +EncryptedXml exml = new EncryptedXml(doc, ev); +``` + + + +## Examples + The following code example creates a new instance of . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/cryptography.Xml.CipherReference/CPP/example.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/CipherData/.ctor/example.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.CipherReference/VB/example.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.CipherReference/VB/example.vb" id="Snippet1"::: + ]]> @@ -78,11 +78,11 @@ EncryptedXml exml = new EncryptedXml(doc, ev); Initializes a new instance of the class. - object that provides reference information for a object. The reference information provides the location of the encrypted data. - + object that provides reference information for a object. The reference information provides the location of the encrypted data. + ]]> @@ -114,20 +114,20 @@ EncryptedXml exml = new EncryptedXml(doc, ev); Initializes a new instance of the class. - object that provides reference information for a object. - - - -## Examples - The following code example creates a new instance of . - + object that provides reference information for a object. + + + +## Examples + The following code example creates a new instance of . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/cryptography.Xml.CipherReference/CPP/example.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/CipherData/.ctor/example.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.CipherReference/VB/example.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.CipherReference/VB/example.vb" id="Snippet1"::: + ]]> @@ -163,42 +163,42 @@ EncryptedXml exml = new EncryptedXml(doc, ev); A Uniform Resource Identifier (URI) pointing to the encrypted data. Initializes a new instance of the class using the specified Uniform Resource Identifier (URI). - object using a Uniform Resource Identifier (URI) that points to the encrypted data. The object is then used to provide reference information for a object. - - You can use a URI to designate an XML file containing encrypted data. For example: - - `String uri = "http://www.woodgrovebank.com/document.xml";` - - You can also use a partial URI to designate that only a portion of an XML document is to be encrypted. For example, assume that an XML document named document.xml contains two `MyForm` elements as shown in the following XML code example: - - `` - - `` - - `` - - `` - - `` - - `` - - You can encrypt only the content in `Form2` using a URI such as the following: - - `String uri = "http://www.woodgrovebank.com/document.xml#Form2";` - - - -## Examples - The following code example creates a new instance of . - + object using a Uniform Resource Identifier (URI) that points to the encrypted data. The object is then used to provide reference information for a object. + + You can use a URI to designate an XML file containing encrypted data. For example: + + `String uri = "http://www.woodgrovebank.com/document.xml";` + + You can also use a partial URI to designate that only a portion of an XML document is to be encrypted. For example, assume that an XML document named document.xml contains two `MyForm` elements as shown in the following XML code example: + + `` + + `` + + `` + + `` + + `` + + `` + + You can encrypt only the content in `Form2` using a URI such as the following: + + `String uri = "http://www.woodgrovebank.com/document.xml#Form2";` + + + +## Examples + The following code example creates a new instance of . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/cryptography.Xml.CipherReference/CPP/example.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/CipherData/.ctor/example.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.CipherReference/VB/example.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.CipherReference/VB/example.vb" id="Snippet1"::: + ]]> @@ -236,20 +236,20 @@ EncryptedXml exml = new EncryptedXml(doc, ev); A object that describes transforms to do on the encrypted data. Initializes a new instance of the class using the specified Uniform Resource Identifier (URI) and transform chain information. - object using a Uniform Resource Identifier (URI) and transform chain to indicate the encrypted data. The object is then used to provide reference information for a object. - - - -## Examples - The following code example creates a new instance of . - + object using a Uniform Resource Identifier (URI) and transform chain to indicate the encrypted data. The object is then used to provide reference information for a object. + + + +## Examples + The following code example creates a new instance of . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/cryptography.Xml.CipherReference/CPP/example.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/CipherData/.ctor/example.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.CipherReference/VB/example.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.CipherReference/VB/example.vb" id="Snippet1"::: + ]]> @@ -286,20 +286,20 @@ EncryptedXml exml = new EncryptedXml(doc, ev); Returns the XML representation of a object. An that represents the element in XML encryption. - ` element in XML. - - - -## Examples - The following code example shows one way to use the method. - + ` element in XML. + + + +## Examples + The following code example shows one way to use the method. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CipherReference2/CPP/example.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/CipherReference/GetXml/example.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CipherReference2/VB/example.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CipherReference2/VB/example.vb" id="Snippet1"::: + ]]> The value is . @@ -349,11 +349,11 @@ EncryptedXml exml = new EncryptedXml(doc, ev); An object that represents an XML element to use as the reference. Loads XML information into the element in XML encryption. - object. - + object. + ]]> The provided is . diff --git a/xml/System.Security.Cryptography.Xml/EncryptedXml.xml b/xml/System.Security.Cryptography.Xml/EncryptedXml.xml index b662bd1cdb6..7c0cb9d4e2f 100644 --- a/xml/System.Security.Cryptography.Xml/EncryptedXml.xml +++ b/xml/System.Security.Cryptography.Xml/EncryptedXml.xml @@ -38,60 +38,60 @@ Represents the process model for implementing XML encryption. - class is the main class used for XML encryption in the .NET Framework. XML Encryption is a standards-based, interoperable way to encrypt all or part of an XML document or any arbitrary data. The .NET Framework XML encryption classes implement the World Wide Web Consortium (W3C) [XML Encryption Syntax and Processing Version 1.0](https://www.w3.org/TR/2002/REC-xmlenc-core-20021210/) specification. - - Use the class whenever you need to share encrypted XML data between applications or organizations in a standard way. Any data encrypted using this class can be decrypted by any implementation of the W3C specification for XML encryption. - - XML encryption replaces any plain text XML element or document with the `` element, which contains an encrypted (or cipher text) representation of plain text XML or any arbitrary data. The `` element can optionally contain information about where to find a key that will decrypt the cipher text, and which cryptographic algorithm was used to encrypt the plain text. - - The `` element is similar to the `` element in style and usage, except that it allows you to encrypt a key that will decrypt the value of the `` element. Note that the `` element and the `` element will never contain an unencrypted key. - - Use one of the following methods to exchange key information: - -- Do not include any key information. If you choose this option, both parties must agree on an algorithm and key before they exchange encrypted data. - -- Include the location of the key in the Uniform Resource Identifier (URI) attribute of the `` element. Both parties must agree on the key location ahead of time and this location must be kept secret. - -- Include a string name that maps to a key in the `` element. Both parties must agree on the key name mapping before they exchange encrypted data and this mapping must be kept secret. - -- Include an encrypted key in the `` element. Both parties must agree on the key that decrypts the encrypted key before they exchange encrypted data. You can optionally include a name or location of the key that will decrypt the key in the `` element. - - - -## Examples - The following code example demonstrates how to create a simple utility class that uses the algorithm to encrypt an XML document. - + class is the main class used for XML encryption in the .NET Framework. XML Encryption is a standards-based, interoperable way to encrypt all or part of an XML document or any arbitrary data. The .NET Framework XML encryption classes implement the World Wide Web Consortium (W3C) [XML Encryption Syntax and Processing Version 1.0](https://www.w3.org/TR/2002/REC-xmlenc-core-20021210/) specification. + + Use the class whenever you need to share encrypted XML data between applications or organizations in a standard way. Any data encrypted using this class can be decrypted by any implementation of the W3C specification for XML encryption. + + XML encryption replaces any plain text XML element or document with the `` element, which contains an encrypted (or cipher text) representation of plain text XML or any arbitrary data. The `` element can optionally contain information about where to find a key that will decrypt the cipher text, and which cryptographic algorithm was used to encrypt the plain text. + + The `` element is similar to the `` element in style and usage, except that it allows you to encrypt a key that will decrypt the value of the `` element. Note that the `` element and the `` element will never contain an unencrypted key. + + Use one of the following methods to exchange key information: + +- Do not include any key information. If you choose this option, both parties must agree on an algorithm and key before they exchange encrypted data. + +- Include the location of the key in the Uniform Resource Identifier (URI) attribute of the `` element. Both parties must agree on the key location ahead of time and this location must be kept secret. + +- Include a string name that maps to a key in the `` element. Both parties must agree on the key name mapping before they exchange encrypted data and this mapping must be kept secret. + +- Include an encrypted key in the `` element. Both parties must agree on the key that decrypts the encrypted key before they exchange encrypted data. You can optionally include a name or location of the key that will decrypt the key in the `` element. + + + +## Examples + The following code example demonstrates how to create a simple utility class that uses the algorithm to encrypt an XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.MainXMLEncDecryptDataOOP/CPP/sample.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.MainXMLEncDecryptDataOOP/VB/sample.vb" id="Snippet1"::: - - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.MainXMLEncDecryptDataOOP/VB/sample.vb" id="Snippet1"::: + + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example embeds a key name in the encrypted XML document that the decrypting method uses to find the appropriate decryption key. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example embeds a key name in the encrypted XML document that the decrypting method uses to find the appropriate decryption key. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKey/CPP/Cryptography.XML.XMLEncMapKey.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample2.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKey/VB/sample.vb" id="Snippet1"::: - - The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKey/VB/sample.vb" id="Snippet1"::: + + The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/CPP/sample.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: - - The following code example demonstrates how to encrypt an XML document using an X.509 certificate. This example creates a symmetric session key to encrypt the document and then uses the X.509 certificate to embed an encrypted version of the session key into the XML document. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: + + The following code example demonstrates how to encrypt an XML document using an X.509 certificate. This example creates a symmetric session key to encrypt the document and then uses the X.509 certificate to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/CPP/Cryptography.XML.XMLEncMapKeyX509.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample3.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/VB/sample.vb" id="Snippet1"::: + ]]> @@ -104,33 +104,33 @@ Initializes a new instance of the class. - @@ -172,38 +172,38 @@ Initializes a new instance of the class. - @@ -249,26 +249,26 @@ An object used to initialize the object. Initializes a new instance of the class using the specified XML document. - object when you want to specify the XML document to encrypt. The `document` parameter comprises the XML elements that later form the encrypted XML. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example embeds a key name in the encrypted XML document that the decrypting method uses to find the appropriate decryption key. - + object when you want to specify the XML document to encrypt. The `document` parameter comprises the XML elements that later form the encrypted XML. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example embeds a key name in the encrypted XML document that the decrypting method uses to find the appropriate decryption key. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKey/CPP/Cryptography.XML.XMLEncMapKey.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample2.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKey/VB/sample.vb" id="Snippet1"::: - - The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKey/VB/sample.vb" id="Snippet1"::: + + The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/CPP/sample.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: + ]]> @@ -324,11 +324,11 @@ An object associated with the object. Initializes a new instance of the class using the specified XML document and evidence. - object when you want to specify the XML document to encrypt and provide security evidence. The `document` parameter comprises the XML elements that later form the encrypted XML. - + object when you want to specify the XML document to encrypt and provide security evidence. The `document` parameter comprises the XML elements that later form the encrypted XML. + ]]> @@ -369,28 +369,28 @@ The symmetric key to map to . Defines a mapping between a key name and a symmetric key or an asymmetric key. - method allows you to map a symmetric key or an asymmetric key to a string name. This method adds the values of the `keyName` and `keyObject` parameters to a table of valid key name mappings. - - Use the method to clear the key name mappings table. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example embeds a key name in the encrypted XML document that the decrypting method uses to find the appropriate decryption key. - + method allows you to map a symmetric key or an asymmetric key to a string name. This method adds the values of the `keyName` and `keyObject` parameters to a table of valid key name mappings. + + Use the method to clear the key name mappings table. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example embeds a key name in the encrypted XML document that the decrypting method uses to find the appropriate decryption key. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecrypt/CPP/Cryptography.XML.XMLEncMinimalDecrypt.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/AddKeyNameMapping/sample.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecrypt/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecrypt/VB/sample.vb" id="Snippet1"::: + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . The value of the parameter is not an RSA algorithm or a symmetric key. @@ -426,11 +426,11 @@ Resets all key name mapping. - method. - + method. + ]]> @@ -472,28 +472,28 @@ Decrypts an element using the specified symmetric algorithm. A byte array that contains the raw decrypted plain text. - method to decrypt an element using a symmetric key. - - Note that the method only decrypts top-level `` tags. In cases where one or more `` tags have been encrypted and are contained within higher level `` tags, you can call the method separately for each one. See the method for a code example. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + method to decrypt an element using a symmetric key. + + Note that the method only decrypts top-level `` tags. In cases where one or more `` tags have been encrypted and are contained within higher level `` tags, you can call the method separately for each one. See the method for a code example. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . @@ -538,38 +538,38 @@ Decrypts all elements of the XML document that were specified during initialization of the class. - method decrypts all `` elements of the XML document loaded during initialization. After you call this method, all `` elements in the document are replaced with plain text versions. - - The method decrypts only top-level `` elements. If you need to decrypt a super-encrypted document (a document that is encrypted more than once), you must call the method repeatedly until all the `` elements have been decrypted. - + method decrypts all `` elements of the XML document loaded during initialization. After you call this method, all `` elements in the document are replaced with plain text versions. + + The method decrypts only top-level `` elements. If you need to decrypt a super-encrypted document (a document that is encrypted more than once), you must call the method repeatedly until all the `` elements have been decrypted. + > [!NOTE] -> The method decrypts only valid XML data. To decrypt arbitrary data, use the method. - - To use XML Encryption with X.509 certificates, you must have the Microsoft Enhanced Cryptographic Provider installed and the X.509 certificate must use the Enhanced Provider. If you do not have the Microsoft Enhanced Cryptographic Provider installed or the X.509 certificate does not use the Enhanced Provider, a with an "Unknown Error" will be thrown when you decrypt an XML document. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. - +> The method decrypts only valid XML data. To decrypt arbitrary data, use the method. + + To use XML Encryption with X.509 certificates, you must have the Microsoft Enhanced Cryptographic Provider installed and the X.509 certificate must use the Enhanced Provider. If you do not have the Microsoft Enhanced Cryptographic Provider installed or the X.509 certificate does not use the Enhanced Provider, a with an "Unknown Error" will be thrown when you decrypt an XML document. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/CPP/sample.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: - - The following code example demonstrates how to encrypt an XML document using an X.509 certificate. This example creates a symmetric session key to encrypt the document and then uses the X.509 certificate to embed an encrypted version of the session key into the XML document. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: + + The following code example demonstrates how to encrypt an XML document using an X.509 certificate. This example creates a symmetric session key to encrypt the document and then uses the X.509 certificate to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/CPP/Cryptography.XML.XMLEncMapKeyX509.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample3.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/VB/sample.vb" id="Snippet1"::: - - The following code example demonstrates how to decrypt a high level `` tag that contains another encrypted `` tag. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/VB/sample.vb" id="Snippet1"::: + + The following code example demonstrates how to decrypt a high level `` tag that contains another encrypted `` tag. + :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/DecryptDocument/sample.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/Cryptography.XML.EncryptedDocument.DecryptDocument-SuperEncryption/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/Cryptography.XML.EncryptedDocument.DecryptDocument-SuperEncryption/VB/sample.vb" id="Snippet1"::: + ]]> The cryptographic key used to decrypt the document was not found. @@ -627,13 +627,13 @@ Determines the key represented by the element. A byte array that contains the key. - method decrypts an encrypted key contained within the `` element of an XML document. - - This recursive method finds the key represented by the object. Note that an object can contain another object that specifies its value. - + method decrypts an encrypted key contained within the `` element of an XML document. + + This recursive method finds the key represented by the object. Note that an object can contain another object that specifies its value. + ]]> The value of the parameter is . @@ -648,11 +648,11 @@ Decrypts an element. - method to decrypt an `` element and retrieve the key used to decrypt that element. - + method to decrypt an `` element and retrieve the key used to decrypt that element. + ]]> @@ -694,17 +694,17 @@ Decrypts an element using a symmetric algorithm. A byte array that contains the plain text key. - method decrypts an encrypted key contained within the `` element of an XML document. This method accepts a value for the `symmetricAlgorithm` parameter that represents either the Triple DES algorithm or the AES key wrap algorithm (also called Rijndael). - + method decrypts an encrypted key contained within the `` element of an XML document. This method accepts a value for the `symmetricAlgorithm` parameter that represents either the Triple DES algorithm or the AES key wrap algorithm (also called Rijndael). + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . The value of the element is not the Triple DES Key Wrap algorithm or the Advanced Encryption Standard (AES) Key Wrap algorithm (also called Rijndael). @@ -748,17 +748,17 @@ Decrypts an element using an asymmetric algorithm. A byte array that contains the plain text key. - method decrypts an encrypted key contained within the `` element of an XML document. This method accepts a value for the `rsa` parameter that represents either the RSA PKCS#1 v1.5 algorithm or the RSA PKCS#1 type 2 algorithm (also called OAEP padding). - + method decrypts an encrypted key contained within the `` element of an XML document. This method accepts a value for the `rsa` parameter that represents either the RSA PKCS#1 v1.5 algorithm or the RSA PKCS#1 type 2 algorithm (also called OAEP padding). + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . @@ -800,11 +800,11 @@ Gets or sets the evidence of the object from which the object is constructed. An object. - object has any security evidence, you should add the evidence to the property. If you do not set this property, any associated objects will not be dereferenced because they will not be granted the required permission set. - + object has any security evidence, you should add the evidence to the property. If you do not set this property, any associated objects will not be dereferenced because they will not be granted the required permission set. + ]]> @@ -840,11 +840,11 @@ Gets or sets the encoding used for XML encryption. An object. - class, such as UTF-16 or ASCII. - + class, such as UTF-16 or ASCII. + ]]> @@ -857,21 +857,21 @@ Encrypts the outer XML of an element using the specified certificate or key in the key mapping table. - @@ -923,30 +923,30 @@ Encrypts the outer XML of an element using the specified X.509 certificate. An element that represents the encrypted XML data. - method is a convenient way to encrypt the outer XML of an element using a certificate. This method generates a 256-bit Advanced Encryption Standard (AES) session key to encrypt an XML element and then encrypts and signs the AES key using the object. The method then returns the resulting XML as an element. - - If you need more control over the encryption, so you can place the encrypted information into a `` element or specify whether the entire XML element or just its contents should be encrypted, use the method overloads. - - To use XML Encryption with X.509 certificates, you must have the Microsoft Enhanced Cryptographic Provider installed and the X.509 certificate must use the Enhanced Provider. If you do not have the Microsoft Enhanced Cryptographic Provider installed or the X.509 certificate does not use the Enhanced Provider, a with an "Unknown Error" will be thrown when you decrypt an XML document. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using an X.509 certificate. This example creates a symmetric session key to encrypt the document and then uses the X.509 certificate to embed an encrypted version of the session key into the XML document. - + method is a convenient way to encrypt the outer XML of an element using a certificate. This method generates a 256-bit Advanced Encryption Standard (AES) session key to encrypt an XML element and then encrypts and signs the AES key using the object. The method then returns the resulting XML as an element. + + If you need more control over the encryption, so you can place the encrypted information into a `` element or specify whether the entire XML element or just its contents should be encrypted, use the method overloads. + + To use XML Encryption with X.509 certificates, you must have the Microsoft Enhanced Cryptographic Provider installed and the X.509 certificate must use the Enhanced Provider. If you do not have the Microsoft Enhanced Cryptographic Provider installed or the X.509 certificate does not use the Enhanced Provider, a with an "Unknown Error" will be thrown when you decrypt an XML document. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using an X.509 certificate. This example creates a symmetric session key to encrypt the document and then uses the X.509 certificate to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/CPP/Cryptography.XML.XMLEncMapKeyX509.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample3.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/VB/sample.vb" id="Snippet1"::: + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . The value of the parameter does not represent an RSA key algorithm. @@ -998,33 +998,33 @@ Encrypts the outer XML of an element using the specified key in the key mapping table. An object that represents the encrypted XML data. - ` element or specify whether the entire XML element or just its contents should be encrypted, use the method overloads. - - For a list of all supported algorithms, see the list of constant fields associated with the class. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. - + ` element or specify whether the entire XML element or just its contents should be encrypted, use the method overloads. + + For a list of all supported algorithms, see the list of constant fields associated with the class. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecrypt/CPP/Cryptography.XML.XMLEncMinimalDecrypt.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/AddKeyNameMapping/sample.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecrypt/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecrypt/VB/sample.vb" id="Snippet1"::: + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . - The value of the parameter does not match a registered key name pair. - - -or- - + The value of the parameter does not match a registered key name pair. + + -or- + The cryptographic key described by the parameter is not supported. @@ -1036,27 +1036,27 @@ Encrypts XML data using a symmetric algorithm. - @@ -1098,38 +1098,38 @@ Encrypts data in the specified byte array using the specified symmetric algorithm. A byte array of encrypted data. - ` element. This method assumes that the data specified in the `plaintext` parameter is a byte array that contains XML data. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + ` element. This method assumes that the data specified in the `plaintext` parameter is a byte array that contains XML data. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example embeds a key name in the encrypted XML document that the decrypting method uses to find the appropriate decryption key. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example embeds a key name in the encrypted XML document that the decrypting method uses to find the appropriate decryption key. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKey/CPP/Cryptography.XML.XMLEncMapKey.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample2.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKey/VB/sample.vb" id="Snippet1"::: - - The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKey/VB/sample.vb" id="Snippet1"::: + + The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/CPP/sample.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . The data could not be encrypted using the specified parameters. @@ -1174,26 +1174,26 @@ Encrypts the specified element or its contents using the specified symmetric algorithm. A byte array that contains the encrypted data. - ` element. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + ` element. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . @@ -1205,20 +1205,20 @@ Encrypts the key that a recipient uses to decrypt an element. - method to encrypt the key that a recipient uses to decrypt an `` element. This method places the encrypted key within an `` element. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. - + method to encrypt the key that a recipient uses to decrypt an `` element. This method places the encrypted key within an `` element. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/CPP/sample.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: + ]]> @@ -1260,19 +1260,19 @@ Encrypts a key using a symmetric algorithm that a recipient uses to decrypt an element. A byte array that represents the encrypted value of the parameter. - method to encrypt the key that a recipient uses to decrypt an `` element. This method accepts a value for the `symmetricAlgorithm` parameter that represents either the Triple DES algorithm or the AES key wrap algorithm (also called Rijndael). - - Note that this method does not automatically place the encrypted key within an `` element. You must manually create the `` element within your document. - + method to encrypt the key that a recipient uses to decrypt an `` element. This method accepts a value for the `symmetricAlgorithm` parameter that represents either the Triple DES algorithm or the AES key wrap algorithm (also called Rijndael). + + Note that this method does not automatically place the encrypted key within an `` element. You must manually create the `` element within your document. + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . The value of the parameter is not the Triple DES Key Wrap algorithm or the Advanced Encryption Standard (AES) Key Wrap algorithm (also called Rijndael). @@ -1316,28 +1316,28 @@ Encrypts the key that a recipient uses to decrypt an element. A byte array that represents the encrypted value of the parameter. - method to encrypt the key that a recipient uses to decrypt an `` element. This method accepts a value for `rsa` that represents either the RSA PKCS#1 v1.5 algorithm or the RSA PKCS#1 type 2 algorithm (also called OAEP). - - Note that this method does not automatically place the encrypted key within an `` element. You must manually create the `` element within your document. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. - + method to encrypt the key that a recipient uses to decrypt an `` element. This method accepts a value for `rsa` that represents either the RSA PKCS#1 v1.5 algorithm or the RSA PKCS#1 type 2 algorithm (also called OAEP). + + Note that this method does not automatically place the encrypted key within an `` element. You must manually create the `` element within your document. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/CPP/sample.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . @@ -1386,20 +1386,20 @@ Retrieves the decryption initialization vector (IV) from an object. A byte array that contains the decryption initialization vector (IV). - object, this method retrieves the decryption initialization vector (IV). The default behavior retrieves the IV as the first bytes of the byte array. - - For a list of Uniform Resource Identifier (URI) values supported by the `symmetricAlgorithmUri` parameter, see the list of constant fields associated with the class. - + object, this method retrieves the decryption initialization vector (IV). The default behavior retrieves the IV as the first bytes of the byte array. + + For a list of Uniform Resource Identifier (URI) values supported by the `symmetricAlgorithmUri` parameter, see the list of constant fields associated with the class. + ]]> The value of the parameter is . - The value of the parameter has an property that is null. - - -or- - + The value of the parameter has an property that is null. + + -or- + The value of the parameter is not a supported algorithm. @@ -1458,18 +1458,18 @@ Retrieves the decryption key from the specified object. A object associated with the decryption key. - object, this method looks for the decryption key that can be used to retrieve the plain text data. If a key name is specified, the method looks for the symmetric algorithm or asymmetric algorithm that is associated with the key name as defined in the key name mapping. Otherwise, if a retrieval method or an object is specified, the method loads the object and calls the method. - + object, this method looks for the decryption key that can be used to retrieve the plain text data. If a key name is specified, the method looks for the symmetric algorithm or asymmetric algorithm that is associated with the key name as defined in the key name mapping. Otherwise, if a retrieval method or an object is specified, the method loads the object and calls the method. + ]]> The value of the parameter is . - The encryptedData parameter has an property that is null. - - -or- - + The encryptedData parameter has an property that is null. + + -or- + The encrypted key cannot be retrieved using the specified parameters. @@ -1517,11 +1517,11 @@ Determines how to resolve internal Uniform Resource Identifier (URI) references. An object that contains an ID indicating how internal Uniform Resource Identifiers (URIs) are to be resolved. - method determines how to resolve internal Uniform Resource Identifiers (URIs). It looks for elements with a specified value or for elements with an ID attribute that has a specified value. - + method determines how to resolve internal Uniform Resource Identifiers (URIs). It looks for elements with a specified value or for elements with an ID attribute that has a specified value. + ]]> @@ -1557,11 +1557,11 @@ Gets or sets the cipher mode used for XML encryption. One of the values. - enumeration, such as Cipher Feedback (CFB) mode. - + enumeration, such as Cipher Feedback (CFB) mode. + ]]> @@ -1597,11 +1597,11 @@ Gets or sets the padding mode used for XML encryption. One of the values that specifies the type of padding used for encryption. - enumeration, such as ANSI X9.23 or PKCS#5. - + enumeration, such as ANSI X9.23 or PKCS#5. + ]]> @@ -1637,13 +1637,13 @@ Gets or sets the recipient of the encrypted key information. The recipient of the encrypted key information. - object referenced by a key name by examining the property. - - Use the property to identify the element that the current recipient can decrypt to retrieve a decryption key. - + object referenced by a key name by examining the property. + + Use the property to identify the element that the current recipient can decrypt to retrieve a decryption key. + ]]> @@ -1684,26 +1684,26 @@ The decrypted data to replace with. Replaces an element with a specified decrypted sequence of bytes. - method replaces an `` element with the value of the `decryptedData` parameter. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + method replaces an `` element with the value of the `decryptedData` parameter. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . @@ -1746,26 +1746,26 @@ to replace only the contents of the element; to replace the entire element. Replaces the specified element with the specified object. - method replaces the `inputElement` parameter with the value specified by the `encryptedData` parameter. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + method replaces the `inputElement` parameter with the value specified by the `encryptedData` parameter. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . @@ -1807,11 +1807,11 @@ Gets or sets the object used by the Document Object Model (DOM) to resolve external XML references. An object. - object used to resolve external XML resources such as entities, document type definitions (DTDs), or schemas. - + object used to resolve external XML resources such as entities, document type definitions (DTDs), or schemas. + ]]> @@ -1843,7 +1843,7 @@ System.Int32 - Gets or sets the XML digital signature recursion depth to prevent infinite recursion and stack overflow. This might happen if the digital signature XML contains the URI which then points back to the original XML. + Gets or sets the XML digital signature recursion depth to prevent infinite recursion and stack overflow. This might happen if the digital signature XML contains the URI that then points back to the original XML. Returns . To be added. @@ -1878,11 +1878,11 @@ Represents the namespace Uniform Resource Identifier (URI) for the 128-bit Advanced Encryption Standard (AES) Key Wrap algorithm (also known as the Rijndael Key Wrap algorithm). This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#kw-aes128)`. - + field is `http://www.w3.org/(2001/04/xmlenc#kw-aes128)`. + ]]> @@ -1917,20 +1917,20 @@ Represents the namespace Uniform Resource Identifier (URI) for the 128-bit Advanced Encryption Standard (AES) algorithm (also known as the Rijndael algorithm). This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#aes128-cbc)`. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + field is `http://www.w3.org/(2001/04/xmlenc#aes128-cbc)`. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> @@ -1965,11 +1965,11 @@ Represents the namespace Uniform Resource Identifier (URI) for the 192-bit Advanced Encryption Standard (AES) Key Wrap algorithm (also known as the Rijndael Key Wrap algorithm). This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#kw-aes192)`. - + field is `http://www.w3.org/(2001/04/xmlenc#kw-aes192)`. + ]]> @@ -2004,20 +2004,20 @@ Represents the namespace Uniform Resource Identifier (URI) for the 192-bit Advanced Encryption Standard (AES) algorithm (also known as the Rijndael algorithm). This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#aes192-cbc)`. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + field is `http://www.w3.org/(2001/04/xmlenc#aes192-cbc)`. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> @@ -2052,11 +2052,11 @@ Represents the namespace Uniform Resource Identifier (URI) for the 256-bit Advanced Encryption Standard (AES) Key Wrap algorithm (also known as the Rijndael Key Wrap algorithm). This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#kw-aes256)`. - + field is `http://www.w3.org/(2001/04/xmlenc#kw-aes256)`. + ]]> @@ -2091,20 +2091,20 @@ Represents the namespace Uniform Resource Identifier (URI) for the 256-bit Advanced Encryption Standard (AES) algorithm (also known as the Rijndael algorithm). This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#aes256-cbc)`. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + field is `http://www.w3.org/(2001/04/xmlenc#aes256-cbc)`. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> @@ -2139,20 +2139,20 @@ Represents the namespace Uniform Resource Identifier (URI) for the Digital Encryption Standard (DES) algorithm. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#des-cbc)`. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + field is `http://www.w3.org/(2001/04/xmlenc#des-cbc)`. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> @@ -2187,11 +2187,11 @@ Represents the namespace Uniform Resource Identifier (URI) for XML encryption element content. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#Content)`. - + field is `http://www.w3.org/(2001/04/xmlenc#Content)`. + ]]> @@ -2226,20 +2226,20 @@ Represents the namespace Uniform Resource Identifier (URI) for an XML encryption element. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#Element)`. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + field is `http://www.w3.org/(2001/04/xmlenc#Element)`. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> @@ -2274,11 +2274,11 @@ Represents the namespace Uniform Resource Identifier (URI) for the XML encryption element. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#EncryptedKey)`. - + field is `http://www.w3.org/(2001/04/xmlenc#EncryptedKey)`. + ]]> @@ -2313,11 +2313,11 @@ Represents the namespace Uniform Resource Identifier (URI) for XML encryption syntax and processing. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#)`. - + field is `http://www.w3.org/(2001/04/xmlenc#)`. + ]]> @@ -2352,20 +2352,20 @@ Represents the namespace Uniform Resource Identifier (URI) for the RSA Public Key Cryptography Standard (PKCS) Version 1.5 algorithm. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#rsa-1_5)`. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. - + field is `http://www.w3.org/(2001/04/xmlenc#rsa-1_5)`. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/CPP/sample.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: + ]]> @@ -2400,11 +2400,11 @@ Represents the namespace Uniform Resource Identifier (URI) for the RSA Optimal Asymmetric Encryption Padding (OAEP) encryption algorithm. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#rsa-oaep-mgf1p)`. - + field is `http://www.w3.org/(2001/04/xmlenc#rsa-oaep-mgf1p)`. + ]]> @@ -2439,11 +2439,11 @@ Represents the namespace Uniform Resource Identifier (URI) for the SHA-256 algorithm. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#sha256)`. - + field is `http://www.w3.org/(2001/04/xmlenc#sha256)`. + ]]> @@ -2478,11 +2478,11 @@ Represents the namespace Uniform Resource Identifier (URI) for the SHA-512 algorithm. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#sha512)`. - + field is `http://www.w3.org/(2001/04/xmlenc#sha512)`. + ]]> @@ -2517,11 +2517,11 @@ Represents the namespace Uniform Resource Identifier (URI) for the TRIPLEDES key wrap algorithm. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#kw-tripledes)`. - + field is `http://www.w3.org/(2001/04/xmlenc#kw-tripledes)`. + ]]> @@ -2556,20 +2556,20 @@ Represents the namespace Uniform Resource Identifier (URI) for the Triple DES algorithm. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#tripledes-cbc)`. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + field is `http://www.w3.org/(2001/04/xmlenc#tripledes-cbc)`. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> diff --git a/xml/System.Security.Cryptography/DSAOpenSsl.xml b/xml/System.Security.Cryptography/DSAOpenSsl.xml index 6cad42133e3..6542083d1ba 100644 --- a/xml/System.Security.Cryptography/DSAOpenSsl.xml +++ b/xml/System.Security.Cryptography/DSAOpenSsl.xml @@ -105,7 +105,7 @@ DSAOpenSSL provides the FIPS 186-3 version of DSA. ## Remarks -This constructor does not generate a new DSA public/private keypair immediately, it just sets the size which will be used to generate a key when one is needed. +This constructor does not generate a new DSA public/private keypair immediately, it just sets the size that will be used to generate a key when one is needed. If key is loaded via the method, or other key import method, the key size from this constructor has no meaning. ]]> @@ -166,7 +166,7 @@ If key is loaded via the method, or other key import method, the `keySize` provided to this constructor has no meaning. ]]> diff --git a/xml/System.Security.Cryptography/ECDiffieHellmanOpenSsl.xml b/xml/System.Security.Cryptography/ECDiffieHellmanOpenSsl.xml index 0f28366d864..edb385d473e 100644 --- a/xml/System.Security.Cryptography/ECDiffieHellmanOpenSsl.xml +++ b/xml/System.Security.Cryptography/ECDiffieHellmanOpenSsl.xml @@ -40,9 +40,9 @@ Provides an implementation of the Elliptic Curve Diffie-Hellman (ECDH) algorithm backed by OpenSSL. - factory methods instead of a specific derived implementation. @@ -94,11 +94,11 @@ This class should only be used directly when doing platform interop with the sys Initializes a new instance of the class with a default curve of NIST P-521/secp521r1. - method, or other key import method, the key size from this constructor has no meaning. ]]> @@ -154,15 +154,15 @@ If key is loaded via the The size of the key to generate, when a key is needed. Initializes a new instance of the class defaulting to the NIST prime curve of the specified size. - constructor or the method. -This constructor does not generate a new public/private keypair immediately, it just sets the size which will be used to generate a key when one is needed. +This constructor does not generate a new public/private keypair immediately, it just sets the size that will be used to generate a key when one is needed. If key is loaded via the method, or other key import method, the key size from this constructor has no meaning. ]]> @@ -221,9 +221,9 @@ If key is loaded via the The OpenSSL EC_KEY* value to use as the key. Initializes a new instance of the class from an existing OpenSSL key represented as an EC_KEY*. - [!IMPORTANT] > OpenSSL supports multiple library versions being loaded within the same process. Before calling this constructor, verify your pointer value came from the same version of OpenSSL that this class uses. For more information, see . @@ -338,9 +338,9 @@ If key is loaded via the The OpenSSL EVP_PKEY* value to use as the key, represented as a . Initializes a new instance of the class from an existing OpenSSL key represented as an EVP_PKEY*. - [!IMPORTANT] > OpenSSL supports multiple library versions being loaded within the same process. Before calling this constructor, verify your pointer value came from the same version of OpenSSL that this class uses. For more information, see . ]]> @@ -561,8 +561,8 @@ This instance represents only a public key. Gets a representation of the cryptographic key. A representation of the cryptographic key. - object with its own lifetime. @@ -633,11 +633,11 @@ The objects returned by this method can safely be used even after this Exports the key used by the object into an object. The key and named curve parameters used by the object. - field contains named curve parameters; otherwise, it contains explicit parameters. - + field contains named curve parameters; otherwise, it contains explicit parameters. + ]]> The method cannot obtain curve values. @@ -668,11 +668,11 @@ The objects returned by this method can safely be used even after this The curve used to generate an ephemeral public/private key pair. Generates a new ephemeral public/private key pair for the specified curve. - method) and must not be implicit. - + method) and must not be implicit. + ]]> @@ -708,11 +708,11 @@ The objects returned by this method can safely be used even after this The curve's parameters to import. Imports the specified parameters for an object as a key into the current instance. - method replaces the existing key that this object is working with by creating a new object. If `parameters` contains only the field, then only a public key is imported. If `parameters` also contains , then a full key pair is be imported. The `parameter` value specifies the type of the curve to import. - + method replaces the existing key that this object is working with by creating a new object. If `parameters` contains only the field, then only a public key is imported. If `parameters` also contains , then a full key pair is be imported. The `parameter` value specifies the type of the curve to import. + ]]> diff --git a/xml/System.Security.Cryptography/SP800108HmacCounterKdf.xml b/xml/System.Security.Cryptography/SP800108HmacCounterKdf.xml index 29a434f3bcb..a186b25bd91 100644 --- a/xml/System.Security.Cryptography/SP800108HmacCounterKdf.xml +++ b/xml/System.Security.Cryptography/SP800108HmacCounterKdf.xml @@ -83,7 +83,7 @@ To be added. - has a which is . + has a that's . -or- @@ -91,7 +91,7 @@ - has a which is empty. + has a that's empty. is not a known or supported hash algorithm. @@ -134,10 +134,10 @@ To be added. - has a which is . + has a that's . - has a which is empty. + has a that's empty. is not a known or supported hash algorithm. @@ -203,11 +203,11 @@ -or- - has a which is . + has a that's . - has a which is empty. + has a that's empty. is negative or larger than the maximum number of bytes @@ -263,8 +263,7 @@ An array containing the derived key. - and will be converted to bytes using the UTF-8 encoding. - for other encodings, perform the conversion using the desired encoding and use an overload which accepts the + and will be converted to bytes using the UTF-8 encoding. For other encodings, perform the conversion using the desired encoding and use an overload that accepts the label and context as a sequence of bytes. @@ -281,11 +280,11 @@ -or- - has a which is . + has a that's . - has a which is empty. + has a that's empty. is negative or larger than the maximum number of bytes @@ -351,10 +350,10 @@ An array containing the derived key. To be added. - has a which is . + has a that's . - has a which is empty. + has a that's empty. is negative or larger than the maximum number of bytes @@ -410,10 +409,10 @@ To be added. - has a which is . + has a that's . - has a which is empty. + has a that's empty. is larger than the maximum number of bytes that can be derived. @@ -475,14 +474,14 @@ An array containing the derived key. and will be converted to bytes using the UTF-8 encoding. - for other encodings, perform the conversion using the desired encoding and use an overload which accepts the + for other encodings, perform the conversion using the desired encoding and use an overload that accepts the label and context as a sequence of bytes. - has a which is . + has a that's . - has a which is empty. + has a that's empty. is negative or larger than the maximum number of bytes @@ -541,14 +540,14 @@ and will be converted to bytes using the UTF-8 encoding. - for other encodings, perform the conversion using the desired encoding and use an overload which accepts the + for other encodings, perform the conversion using the desired encoding and use an overload that accepts the label and context as a sequence of bytes. - has a which is . + has a that's . - has a which is empty. + has a that's empty. is larger than the maximum number of bytes that can be derived. @@ -763,7 +762,7 @@ An array containing the derived key. and will be converted to bytes using the UTF-8 encoding. - for other encodings, perform the conversion using the desired encoding and use an overload which accepts the + for other encodings, perform the conversion using the desired encoding and use an overload that accepts the label and context as a sequence of bytes. @@ -813,7 +812,7 @@ and will be converted to bytes using the UTF-8 encoding. - for other encodings, perform the conversion using the desired encoding and use an overload which accepts the + for other encodings, perform the conversion using the desired encoding and use an overload that accepts the label and context as a sequence of bytes. @@ -863,7 +862,7 @@ An array containing the derived key. and will be converted to bytes using the UTF-8 encoding. - for other encodings, perform the conversion using the desired encoding and use an overload which accepts the + for other encodings, perform the conversion using the desired encoding and use an overload that accepts the label and context as a sequence of bytes. diff --git a/xml/System.Security.Cryptography/Shake128.xml b/xml/System.Security.Cryptography/Shake128.xml index 67b6388b3fa..3197c79859d 100644 --- a/xml/System.Security.Cryptography/Shake128.xml +++ b/xml/System.Security.Cryptography/Shake128.xml @@ -21,7 +21,7 @@ Computes the SHAKE128 hash for the input data. - This algorithm is specified by FIPS 202. The SHAKE algorithm family is an extendable-output function (XOF) which allows the output to be extended to any length. The size of the XOF indicates the security strength of the algorithm, not the output size. + This algorithm is specified by FIPS 202. The SHAKE algorithm family is an extendable-output function (XOF) that allows the output to be extended to any length. The size of the XOF indicates the security strength of the algorithm, not the output size. diff --git a/xml/System.Security.Cryptography/Shake256.xml b/xml/System.Security.Cryptography/Shake256.xml index fd43cc89f74..f311d6f1b4f 100644 --- a/xml/System.Security.Cryptography/Shake256.xml +++ b/xml/System.Security.Cryptography/Shake256.xml @@ -21,7 +21,7 @@ Computes the SHAKE256 hash for the input data. - This algorithm is specified by FIPS 202. The SHAKE algorithm family is an extendable-output function (XOF) which allows the output to be extended to any length. The size of the XOF indicates the security strength of the algorithm, not the output size. + This algorithm is specified by FIPS 202. The SHAKE algorithm family is an extendable-output function (XOF) that allows the output to be extended to any length. The size of the XOF indicates the security strength of the algorithm, not the output size. diff --git a/xml/System.Security.Permissions/StrongNameIdentityPermission.xml b/xml/System.Security.Permissions/StrongNameIdentityPermission.xml index c294196d6cf..c2b05faf7e3 100644 --- a/xml/System.Security.Permissions/StrongNameIdentityPermission.xml +++ b/xml/System.Security.Permissions/StrongNameIdentityPermission.xml @@ -49,29 +49,29 @@ Defines the identity permission for strong names. This class cannot be inherited. - [!IMPORTANT] -> Starting with the .NET Framework 4, identity permissions are not used. -> -> In the .NET Framework versions 1.0 and 1.1, identity permissions cannot have an permission state value. In the .NET Framework version 2.0 and later, identity permissions can have any permission state value. This means that in version 2.0 and later versions, identity permissions have the same behavior as permissions that implement the interface. That is, a demand for an identity always succeeds, regardless of the identity of the assembly, if the assembly has been granted full trust. - - Use to confirm that the calling code is in a particular strong-named code assembly. Full demands for succeed only if all the assemblies in the stack have the correct evidence to satisfy the demand. Link demands that use the attribute succeed only if the immediate caller has the correct evidence. - - A strong name identity is based on a cryptographic public key called a binary large object (BLOB), which is optionally combined with the name and version of a specific assembly. The key defines a unique namespace and provides strong verification that the name is genuine, because the definition of the name must be in an assembly that is signed by the corresponding private key. - - Note that the validity of the strong name key is not dependent on a trust relationship or on any certificate necessarily being issued for the key. - - In the .NET Framework versions 1.0 and 1.1, demands on the identity permissions are effective even when the calling assembly is fully trusted. That is, even if the calling assembly has full trust, a demand for an identity permission fails if the assembly does not meet the demanded criteria. In the .NET Framework version 2.0 and later, demands for identity permissions are ineffective if the calling assembly has full trust. This ensures consistency for all permissions and eliminates the treatment of identity permissions as a special case. - - For a complete description of strong names, see the reference page. For more information about strong-named assemblies, see [Strong-named assemblies](/dotnet/standard/assembly/strong-named). - - The class is used to define strong-name requirements for accessing the public members of a type. The attribute can be used to define strong-name requirements at the assembly level. In the .NET Framework version 2.0 and later, you can also use the attribute to specify that all nonpublic types in that assembly are visible to another assembly. For more information, see [Friend assemblies](/dotnet/standard/assembly/friend). - +> Starting with the .NET Framework 4, identity permissions are not used. +> +> In the .NET Framework versions 1.0 and 1.1, identity permissions cannot have an permission state value. In the .NET Framework version 2.0 and later, identity permissions can have any permission state value. This means that in version 2.0 and later versions, identity permissions have the same behavior as permissions that implement the interface. That is, a demand for an identity always succeeds, regardless of the identity of the assembly, if the assembly has been granted full trust. + + Use to confirm that the calling code is in a particular strong-named code assembly. Full demands for succeed only if all the assemblies in the stack have the correct evidence to satisfy the demand. Link demands that use the attribute succeed only if the immediate caller has the correct evidence. + + A strong name identity is based on a cryptographic public key called a binary large object (BLOB), which is optionally combined with the name and version of a specific assembly. The key defines a unique namespace and provides strong verification that the name is genuine, because the definition of the name must be in an assembly that is signed by the corresponding private key. + + Note that the validity of the strong name key is not dependent on a trust relationship or on any certificate necessarily being issued for the key. + + In the .NET Framework versions 1.0 and 1.1, demands on the identity permissions are effective even when the calling assembly is fully trusted. That is, even if the calling assembly has full trust, a demand for an identity permission fails if the assembly does not meet the demanded criteria. In the .NET Framework version 2.0 and later, demands for identity permissions are ineffective if the calling assembly has full trust. This ensures consistency for all permissions and eliminates the treatment of identity permissions as a special case. + + For a complete description of strong names, see the reference page. For more information about strong-named assemblies, see [Strong-named assemblies](/dotnet/standard/assembly/strong-named). + + The class is used to define strong-name requirements for accessing the public members of a type. The attribute can be used to define strong-name requirements at the assembly level. In the .NET Framework version 2.0 and later, you can also use the attribute to specify that all nonpublic types in that assembly are visible to another assembly. For more information, see [Friend assemblies](/dotnet/standard/assembly/friend). + ]]> @@ -125,27 +125,27 @@ One of the values. Initializes a new instance of the class with the specified . - [!NOTE] -> In the .NET Framework versions 1.0 and 1.1, identity permissions cannot have an permission state value. In the .NET Framework version 2.0 and later, identity permissions can have any permission state value. This means that in version 2.0 and later versions, identity permissions have the same behavior as permissions that implement the interface. That is, a demand for an identity always succeeds, regardless of the identity of the assembly, if the assembly has been granted full trust. - - In the .NET Framework versions 1.0 and 1.1, demands on the identity permissions are effective, even when the calling assembly is fully trusted. That is, although the calling assembly has full trust, a demand for an identity permission fails if the assembly does not meet the demanded criteria. In the .NET Framework version 2.0 and later, demands for identity permissions are ineffective if the calling assembly has full trust. This assures consistency for all permissions, eliminating the treatment of identity permissions as a special case. - - Use this constructor with a permission state value of to create an identity permission that matches no strong names. If you subsequently set the and properties, a specific strong name identity can be represented by the permission. - - - -## Examples - The following code example shows the use of the constructor. - +> In the .NET Framework versions 1.0 and 1.1, identity permissions cannot have an permission state value. In the .NET Framework version 2.0 and later, identity permissions can have any permission state value. This means that in version 2.0 and later versions, identity permissions have the same behavior as permissions that implement the interface. That is, a demand for an identity always succeeds, regardless of the identity of the assembly, if the assembly has been granted full trust. + + In the .NET Framework versions 1.0 and 1.1, demands on the identity permissions are effective, even when the calling assembly is fully trusted. That is, although the calling assembly has full trust, a demand for an identity permission fails if the assembly does not meet the demanded criteria. In the .NET Framework version 2.0 and later, demands for identity permissions are ineffective if the calling assembly has full trust. This assures consistency for all permissions, eliminating the treatment of identity permissions as a special case. + + Use this constructor with a permission state value of to create an identity permission that matches no strong names. If you subsequently set the and properties, a specific strong name identity can be represented by the permission. + + + +## Examples + The following code example shows the use of the constructor. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/CPP/strongnameidentity.cpp" id="Snippet7"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Permissions/StrongNameIdentityPermission/.ctor/strongnameidentity.cs" id="Snippet7"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/VB/strongnameidentity.vb" id="Snippet7"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/VB/strongnameidentity.vb" id="Snippet7"::: + ]]> The parameter is not a valid value of . @@ -188,22 +188,22 @@ The version number of the identity. Initializes a new instance of the class for the specified strong name identity. - is thrown. - - For more information on names and version numbers of assemblies, see [Strong-named assemblies](/dotnet/standard/assembly/strong-named). - - - -## Examples - The following code example shows the use of the constructor. - + is thrown. + + For more information on names and version numbers of assemblies, see [Strong-named assemblies](/dotnet/standard/assembly/strong-named). + + + +## Examples + The following code example shows the use of the constructor. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/CPP/strongnameidentity.cpp" id="Snippet8"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Permissions/StrongNameIdentityPermission/.ctor/strongnameidentity.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/VB/strongnameidentity.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/VB/strongnameidentity.vb" id="Snippet8"::: + ]]> The parameter is . @@ -244,23 +244,23 @@ Creates and returns an identical copy of the current permission. A copy of the current permission. - method. This example is part of a larger example provided for the class. The best use for this example is to build and execute the entire example, and view its output. - + method. This example is part of a larger example provided for the class. The best use for this example is to build and execute the entire example, and view its output. + > [!NOTE] -> The code example is intended to show the behavior of the method, not to demonstrate its use. In general, the methods of permission classes are used by the security infrastructure; they are not typically used in applications. - +> The code example is intended to show the behavior of the method, not to demonstrate its use. In general, the methods of permission classes are used by the security infrastructure; they are not typically used in applications. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/CPP/strongnameidentity.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Permissions/StrongNameIdentityPermission/.ctor/strongnameidentity.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/VB/strongnameidentity.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/VB/strongnameidentity.vb" id="Snippet5"::: + ]]> @@ -301,30 +301,30 @@ The XML encoding to use to reconstruct the permission. Reconstructs a permission with a specified state from an XML encoding. - method. This example is part of a larger example provided for the class. The best use for this example is to build and execute the entire example, and view its output. - + method. This example is part of a larger example provided for the class. The best use for this example is to build and execute the entire example, and view its output. + > [!NOTE] -> The code example is intended to show the behavior of the method, not to demonstrate its use. In general, the methods of permission classes are used by the security infrastructure; they are not typically used in applications. - +> The code example is intended to show the behavior of the method, not to demonstrate its use. In general, the methods of permission classes are used by the security infrastructure; they are not typically used in applications. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/CPP/strongnameidentity.cpp" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Permissions/StrongNameIdentityPermission/.ctor/strongnameidentity.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/VB/strongnameidentity.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/VB/strongnameidentity.vb" id="Snippet6"::: + ]]> The parameter is . - The parameter is not a valid permission element. - - -or- - + The parameter is not a valid permission element. + + -or- + The parameter's version number is not valid. @@ -365,25 +365,25 @@ Creates and returns a permission that is the intersection of the current permission and the specified permission. A new permission that represents the intersection of the current permission and the specified permission, or if the intersection is empty. - method, not how to use the method. This example is part of a larger example provided for the class. The best use for this example is to build and execute the entire example, and view its output. - + method, not how to use the method. This example is part of a larger example provided for the class. The best use for this example is to build and execute the entire example, and view its output. + > [!NOTE] -> The code example is intended to show the behavior of the method, not to demonstrate its use. In general, the methods of permission classes are used by the security infrastructure; they are not typically used in applications. - +> The code example is intended to show the behavior of the method, not to demonstrate its use. In general, the methods of permission classes are used by the security infrastructure; they are not typically used in applications. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/CPP/strongnameidentity.cpp" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Permissions/StrongNameIdentityPermission/.ctor/strongnameidentity.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/VB/strongnameidentity.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/VB/strongnameidentity.vb" id="Snippet4"::: + ]]> The parameter is not and is not of the same type as the current permission. @@ -427,23 +427,23 @@ if the current permission is a subset of the specified permission; otherwise, . - property containing the wildcard expression MyCompany.MyDepartment.* is identified as a subset of an identity with the property MyCompany.MyDepartment.MyFile. - - - -## Examples - The following code example shows the results of the use of the method, not how to use the method. This example is part of a larger example provided for the class. The best use for this example is to build and execute the entire example, and view its output. - + property containing the wildcard expression MyCompany.MyDepartment.* is identified as a subset of an identity with the property MyCompany.MyDepartment.MyFile. + + + +## Examples + The following code example shows the results of the use of the method, not how to use the method. This example is part of a larger example provided for the class. The best use for this example is to build and execute the entire example, and view its output. + > [!NOTE] -> The code example is intended to show the behavior of the method, not to demonstrate its use. In general, the methods of permission classes are used by the security infrastructure; they are not typically used in applications. - +> The code example is intended to show the behavior of the method, not to demonstrate its use. In general, the methods of permission classes are used by the security infrastructure; they are not typically used in applications. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/CPP/strongnameidentity.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Permissions/StrongNameIdentityPermission/.ctor/strongnameidentity.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/VB/strongnameidentity.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/VB/strongnameidentity.vb" id="Snippet2"::: + ]]> The parameter is not and is not of the same type as the current permission. @@ -482,11 +482,11 @@ Gets or sets the simple name portion of the strong name identity. The simple name of the identity. - property can be an exact name or can be modified by a wildcard character in the final position; for example, both MyCompany.MyDepartment.MyFile and MyCompany.MyDepartment.* are valid names. If you attempt to set the property to an empty string (""), an is thrown. - + property can be an exact name or can be modified by a wildcard character in the final position; for example, both MyCompany.MyDepartment.MyFile and MyCompany.MyDepartment.* are valid names. If you attempt to set the property to an empty string (""), an is thrown. + ]]> The value is an empty string (""). @@ -564,23 +564,23 @@ Creates an XML encoding of the permission and its current state. An XML encoding of the permission, including any state information. - method. - + method. + > [!NOTE] -> The code example is intended to show the behavior of the method, not to demonstrate its use. In general, the methods of permission classes are used by the security infrastructure; they are not typically used in applications. - +> The code example is intended to show the behavior of the method, not to demonstrate its use. In general, the methods of permission classes are used by the security infrastructure; they are not typically used in applications. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/CPP/strongnameidentity.cpp" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Permissions/StrongNameIdentityPermission/.ctor/strongnameidentity.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/VB/strongnameidentity.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/VB/strongnameidentity.vb" id="Snippet6"::: + ]]> @@ -622,31 +622,31 @@ Creates a permission that is the union of the current permission and the specified permission. A new permission that represents the union of the current permission and the specified permission. - is a permission that represents all the operations represented by both the current permission and the specified permission. Any demand that passes either permission passes their union. - - The union of a permission and `null` is the permission that is not `null`. The union of a permission and a subset of that permission is the permission that contains the other. Any other combination results in an exception being thrown. - - - -## Examples - The following code example shows the results of the use of the method, not how to use the method. This example is part of a larger example provided for the class. The best use for this example is to build and execute the entire example, and view its output. - + is a permission that represents all the operations represented by both the current permission and the specified permission. Any demand that passes either permission passes their union. + + The union of a permission and `null` is the permission that is not `null`. The union of a permission and a subset of that permission is the permission that contains the other. Any other combination results in an exception being thrown. + + + +## Examples + The following code example shows the results of the use of the method, not how to use the method. This example is part of a larger example provided for the class. The best use for this example is to build and execute the entire example, and view its output. + > [!NOTE] -> The code example is intended to show the behavior of the method, not to demonstrate its use. In general, the methods of permission classes are used by the security infrastructure; they are not typically used in applications. - +> The code example is intended to show the behavior of the method, not to demonstrate its use. In general, the methods of permission classes are used by the security infrastructure; they are not typically used in applications. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/CPP/strongnameidentity.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Permissions/StrongNameIdentityPermission/.ctor/strongnameidentity.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/VB/strongnameidentity.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.Permissions.StrongNameIdentityPermission/VB/strongnameidentity.vb" id="Snippet3"::: + ]]> - The parameter is not and is not of the same type as the current permission. - - -or- - + The parameter is not and is not of the same type as the current permission. + + -or- + The two permissions are not equal and one is a subset of the other. diff --git a/xml/System.Security.RightsManagement/ContentGrant.xml b/xml/System.Security.RightsManagement/ContentGrant.xml index c31e4ccf852..393b487fa47 100644 --- a/xml/System.Security.RightsManagement/ContentGrant.xml +++ b/xml/System.Security.RightsManagement/ContentGrant.xml @@ -29,11 +29,11 @@ Represents a right granted to a user to access information in a rights managed document. - types, is only usable in full trust applications. - + types, is only usable in full trust applications. + ]]> @@ -79,17 +79,17 @@ The access right that is granted. Initializes a new instance of the class that grants a specified a specified . - instance with no date or time limitations. - -- The property is set to . which indicates there is no starting limitation. - -- The property is set to . which indicates there is no ending limitation. - - Use the alternate constructor to create an instance with date and time limitations. - + instance with no date or time limitations. + +- The property is set to ., which indicates there is no starting limitation. + +- The property is set to ., which indicates there is no ending limitation. + + Use the alternate constructor to create an instance with date and time limitations. + ]]> @@ -130,13 +130,13 @@ The ending date and time that the right expires. Initializes a new instance of the class that grants a specified a specified for a specified duration. - . if there is no start date and time limitation. - - Specify the `validUntil` parameter with . if there is no end date and time limitation. - + . if there is no start date and time limitation. + + Specify the `validUntil` parameter with . if there is no end date and time limitation. + ]]> diff --git a/xml/System.Text.Json.Serialization.Metadata/JsonParameterInfo.xml b/xml/System.Text.Json.Serialization.Metadata/JsonParameterInfo.xml index d6023464fbd..87a6b9cb5ac 100644 --- a/xml/System.Text.Json.Serialization.Metadata/JsonParameterInfo.xml +++ b/xml/System.Text.Json.Serialization.Metadata/JsonParameterInfo.xml @@ -148,7 +148,7 @@ Gets a value indicating whether the parameter represents a required or init-only member initializer. To be added. - Only returns for source generated metadata which can only access + Only returns for source-generated metadata that can only access required or init-only member initializers using object initialize expressions. diff --git a/xml/System.Text.Json/JsonSerializer.xml b/xml/System.Text.Json/JsonSerializer.xml index 800a822fe9a..a94a915f4ff 100644 --- a/xml/System.Text.Json/JsonSerializer.xml +++ b/xml/System.Text.Json/JsonSerializer.xml @@ -2749,7 +2749,7 @@ There is remaining data in the stream. The type to deserialize the JSON value into. JSON data to parse. Metadata about the type to convert. - The which may be used to cancel the read operation. + The that can be used to cancel the read operation. Reads the UTF-8 encoded text representing a single JSON value into a . The Stream will be read to completion. A representation of the JSON value. @@ -2814,7 +2814,7 @@ There is remaining data in the stream. The element type to deserialize asynchronously. JSON data to parse. Options to control the behavior during reading. - The which may be used to cancel the read operation. + The that can be used to cancel the read operation. Wraps the UTF-8 encoded text into an that can be used to deserialize root-level JSON arrays in a streaming manner. An representation of the provided JSON array. To be added. diff --git a/xml/System.Text/CodePagesEncodingProvider.xml b/xml/System.Text/CodePagesEncodingProvider.xml index 72ee77025bd..149ac295a93 100644 --- a/xml/System.Text/CodePagesEncodingProvider.xml +++ b/xml/System.Text/CodePagesEncodingProvider.xml @@ -151,7 +151,7 @@ The .NET Framework supports a large number of character encodings and code pages - The code page identifier of the preferred encoding which the encoding provider may support. + The code page identifier of the preferred encoding that the encoding provider might support. Returns the encoding associated with the specified code page identifier. The encoding associated with the specified code page identifier, or if the provider does not support the requested codepage encoding. To be added. @@ -190,7 +190,7 @@ The .NET Framework supports a large number of character encodings and code pages - The code page name of the preferred encoding which the encoding provider may support. + The code page name of the preferred encoding that the encoding provider might support. Returns the encoding associated with the specified code page name. The encoding associated with the specified code page, or if the provider does not support the requested encoding. To be added. diff --git a/xml/System.Text/EncodingExtensions.xml b/xml/System.Text/EncodingExtensions.xml index 2451cf72144..21df242bd09 100644 --- a/xml/System.Text/EncodingExtensions.xml +++ b/xml/System.Text/EncodingExtensions.xml @@ -604,7 +604,7 @@ The encoding that represents how the data in is encoded. The sequence to decode into characters. Decodes the specified into a using the specified . - A which represents the decoded contents of . + The decoded contents of . To be added. contains data that cannot be decoded and is configured to throw when such data is seen. diff --git a/xml/ns-System.ComponentModel.Design.xml b/xml/ns-System.ComponentModel.Design.xml index 6f7f7246c09..04a0f404dd7 100644 --- a/xml/ns-System.ComponentModel.Design.xml +++ b/xml/ns-System.ComponentModel.Design.xml @@ -1,59 +1,41 @@ - Contains classes that developers can use to build custom design-time behavior for components and user interfaces for configuring components at design time. The design time environment provides systems that enable developers to arrange components and configure their properties. Some components may require specific design-time only behavior to function properly in a design time environment. It may also be valuable to provide custom user interfaces which assist developers in configuring components or the values of complex data types. The classes and interfaces defined within this namespace can be used to build design-time behavior for components, access design-time services, and implement customized design-time configuration interfaces. + Contains classes that developers can use to build custom design-time behavior for components and user interfaces for configuring components at design time. The design-time environment provides systems that enable developers to arrange components and configure their properties. Some components might require specific design-time only behavior to function properly in a design-time environment. It might also be valuable to provide custom user interfaces that assist developers in configuring components or the values of complex data types. The classes and interfaces defined within this namespace can be used to build design-time behavior for components, access design-time services, and implement customized design-time configuration interfaces. interface that you can use to customize design-time behavior for specific types of components. - -- A class that provides a more sophisticated designer base class which implements the , , and interfaces. - -- Designer interfaces and services that enable a designer to support additional functionality, including: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -- Classes that can be used to customize design-time license context management and serialization: and . - -- Simple collection editors that can be extended: and . +- A basic interface that you can use to customize design-time behavior for specific types of components. + +- A class that provides a more sophisticated designer base class that implements the , , and interfaces. + +- Designer interfaces and services that enable a designer to support additional functionality, including: + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + +- Classes that can be used to customize design-time license context management and serialization: and . + +- Simple collection editors that can be extended: and . ]]> diff --git a/xml/ns-System.Net.PeerToPeer.xml b/xml/ns-System.Net.PeerToPeer.xml index 0951db3c0d7..e48dba0c3b9 100644 --- a/xml/ns-System.Net.PeerToPeer.xml +++ b/xml/ns-System.Net.PeerToPeer.xml @@ -5,19 +5,15 @@ in a completely peer-to-peer manner. + Peer Name Resolution Protocol (PNRP) provides a name resolution mechanism for peer-to-peer networks. PNRP is designed to resolve a name to a network in a completely peer-to-peer manner. - Basic PNRP functionality is provided in the namespace classes. They provide the ability to create a peer and register it in a of peers. They also provide the ability to resolve a to its network endpoint, TCP port, cloud, or other address identifier(s). + Basic PNRP functionality is provided in the namespace classes. They provide the ability to create a peer and register it in a of peers. They also provide the ability to resolve a to its network endpoint, TCP port, cloud, or other address identifiers. Advanced functionality for peer-to-peer networking is provided in the namespace. - In Windows Vista, PNRP ships as a service that is started on demand by applications. In addition, there is a PNRP machine registration service that can be manually enabled by applications or users if they want to publish machine names for remote connections and communications. - - PNRP version 1 was included in Windows XP Service Pack 2 (SP2), Windows XP Professional x64 Edition, and Windows XP with Service Pack 1 (SP1) and the Advanced Networking Pack for Windows XP. - - In addition, there is a PNRP machine registration service which can be manually enabled by applications/users if there is interest in publishing machine names for remote connection and communication. + In Windows, PNRP ships as a service that's started on demand by applications. In addition, there is a PNRP machine registration service that can be manually enabled by applications or users if they want to publish machine names for remote connections and communications. ]]> diff --git a/xml/ns-System.Runtime.InteropServices.Expando.xml b/xml/ns-System.Runtime.InteropServices.Expando.xml index e0d7a838a64..6ba43e7bb58 100644 --- a/xml/ns-System.Runtime.InteropServices.Expando.xml +++ b/xml/ns-System.Runtime.InteropServices.Expando.xml @@ -1,6 +1,6 @@ - Contains the interface which allows modification of an object by adding or removing its members. + Contains the interface, which allows modification of an object by adding or removing its members. To be added. diff --git a/xml/ns-System.ServiceProcess.xml b/xml/ns-System.ServiceProcess.xml index 35df339c721..026b71f64c4 100644 --- a/xml/ns-System.ServiceProcess.xml +++ b/xml/ns-System.ServiceProcess.xml @@ -5,7 +5,7 @@ namespace provides installation classes that write service information to the registry. The class provides an encompassing class which installs components common to all the services in an installation. For each service, you create an instance of the class to install service-specific functionality. + Services are installed using an installation utility such as InstallUtil.exe. The namespace provides installation classes that write service information to the registry. The class provides an encompassing class that installs components common to all the services in an installation. For each service, you create an instance of the class to install service-specific functionality. The class enables you to connect to an existing service and manipulate it or get information about it. This class is typically used in an administrative capacity, and enables you to start, stop, pause, continue, or perform custom commands on a service. Where the class defines the processing a service performs when a command occurs, the is the agent that enables you to call those commands on the service. diff --git a/xml/ns-System.Speech.Recognition.xml b/xml/ns-System.Speech.Recognition.xml index fd3039b223f..3f03e6d7127 100644 --- a/xml/ns-System.Speech.Recognition.xml +++ b/xml/ns-System.Speech.Recognition.xml @@ -5,9 +5,9 @@ namespace to access and extend this basic speech recognition technology by defining algorithms for identifying and acting on specific phrases or word patterns, and by managing the runtime behavior of this speech infrastructure. + Applications use the namespace to access and extend this basic speech recognition technology by defining algorithms for identifying and acting on specific phrases or word patterns, and by managing the run-time behavior of this speech infrastructure. **Create Grammars** @@ -17,8 +17,6 @@ In addition, the class provides a special-case grammar to support a conventional dictation model. - See [Create Grammars](https://learn.microsoft.com/previous-versions/office/developer/speech-technologies/hh361675(v=office.14)) in the [System Speech Programming Guide for .NET Framework](https://learn.microsoft.com/previous-versions/office/developer/speech-technologies/hh361625(v%3doffice.14)) for more information and examples. - **Manage Speech Recognition Engines** Instances of and supplied with objects provide the primary access to the speech recognition engines of the Windows Desktop Speech Technology. @@ -27,27 +25,19 @@ For more control over the configuration and type of recognition engine, build an application using , which runs in-process. Using the class, you can also dynamically select audio input from devices, files, or streams. - See [Initialize and Manage a Speech Recognition Engine](https://learn.microsoft.com/previous-versions/office/developer/speech-technologies/hh361636(v=office.14)) in the [System Speech Programming Guide for .NET Framework](https://learn.microsoft.com/previous-versions/office/developer/speech-technologies/hh361625(v%3doffice.14)) for more information. - **Respond to Events** - and objects generate events in response to audio input to the speech recognition engine. The `AudioLevelUpdated`, `AudioSignalProblemOccurred`, `AudioStateChanged` events are raised in response to changes in the incoming signal. The `SpeechDetected` event is raised when the speech recognition engine identifies incoming audio as speech. The speech recognition engine raises the `SpeechRecognized` event when it matches speech input to one of its loaded grammars, and raises the `SpeechRecognitionRejected` when speech input does not match any of its loaded grammars. + and objects generate events in response to audio input to the speech recognition engine. The `AudioLevelUpdated`, `AudioSignalProblemOccurred`, and `AudioStateChanged` events are raised in response to changes in the incoming signal. The `SpeechDetected` event is raised when the speech recognition engine identifies incoming audio as speech. The speech recognition engine raises the `SpeechRecognized` event when it matches speech input to one of its loaded grammars, and raises the `SpeechRecognitionRejected` when speech input does not match any of its loaded grammars. - Other types of events include the `LoadGrammarCompleted` event which a speech recognition engine raises when it has loaded a grammar. The is exclusive to the class, which raises the event when the state of Windows Speech Recognition changes. + Other types of events include the `LoadGrammarCompleted` event, which a speech recognition engine raises when it has loaded a grammar. The is exclusive to the class, which raises the event when the state of Windows Speech Recognition changes. You can register to be notified for events that the speech recognition engine raises and create handlers using the `EventsArgs` classes associated with each of these events to program your application's behavior when an event is raised. - See [Using Speech Recognition Events](https://learn.microsoft.com/previous-versions/office/developer/speech-technologies/hh361573(v=office.14)) in the [System Speech Programming Guide for .NET Framework](https://learn.microsoft.com/previous-versions/office/developer/speech-technologies/hh361625(v%3doffice.14)) for more information. - ]]> - Speech Recognition - Create Grammars - Initialize and Manage a Speech Recognition Engine - Using Speech Recognition Events diff --git a/xml/ns-System.Threading.Tasks.xml b/xml/ns-System.Threading.Tasks.xml index d7a9aab72cc..514f64b276e 100644 --- a/xml/ns-System.Threading.Tasks.xml +++ b/xml/ns-System.Threading.Tasks.xml @@ -1,7 +1,7 @@ - Provides types that simplify the work of writing concurrent and asynchronous code. The main types are which represents an asynchronous operation that can be waited on and cancelled, and , which is a task that can return a value. The class provides static methods for creating and starting tasks, and the class provides the default thread scheduling infrastructure. + Provides types that simplify the work of writing concurrent and asynchronous code. The main types are , which represents an asynchronous operation that can be waited on and cancelled, and , which is a task that can return a value. The class provides static methods for creating and starting tasks, and the class provides the default thread scheduling infrastructure. To be added. - Parallel Programming in the .NET Framework + Parallel programming in .NET diff --git a/xml/ns-System.Xml.Resolvers.xml b/xml/ns-System.Xml.Resolvers.xml index 8c7bae9dd75..965cd1c2f6d 100644 --- a/xml/ns-System.Xml.Resolvers.xml +++ b/xml/ns-System.Xml.Resolvers.xml @@ -11,7 +11,7 @@ The enumeration defines which well-known DTDs the recognizes. The enumeration contains the `Xhtml10`, `Rss091`, `All`, and `None` values. - `XmlKnownDtd.Xhtml10` specifies that the `T:System.Xml.Resolvers.XmlPreloadedResolver` will recognize DTDs and entities that are defined in XHTML 1.0. For more information about XHTML, see the [XHTML 1.0 specification](https://go.microsoft.com/fwlink/?LinkID=109812). + `XmlKnownDtd.Xhtml10` specifies that the `T:System.Xml.Resolvers.XmlPreloadedResolver` will recognize DTDs and entities that are defined in XHTML 1.0. For more information about XHTML, see the [XHTML 1.0 specification](https://www.w3.org/TR/xhtml1/). `XmlKnownDtd.Rss091` specifies that the `T:System.Xml.Resolvers.XmlPreloadedResolver` will recognize DTDs and entities that are defined in RSS 0.91. @@ -20,7 +20,7 @@ `XmlKnownDtd.None` specifies that the will not recognize any of the predefined DTDs. > [!NOTE] -> When the preloads a well-known DTD, it does not invoke network connections because the DTDs are already embedded in the System.Xml.Utils assembly. +> When the preloads a well-known DTD, it does not invoke network connections because the DTDs are already embedded in the System.Xml.Utils assembly. ]]> diff --git a/xml/ns-System.Xml.xml b/xml/ns-System.Xml.xml index 931a2037868..dc8d2c2ccfe 100644 --- a/xml/ns-System.Xml.xml +++ b/xml/ns-System.Xml.xml @@ -11,41 +11,30 @@ The namespace supports these standards: - [XML 1.0, including DTD support](https://www.w3.org/TR/2006/REC-xml-20060816/) - - [XML namespaces](https://www.w3.org/TR/REC-xml-names/), both stream-level and DOM - - [XML schemas](https://www.w3.org/2001/XMLSchema) - - [XPath expressions](https://www.w3.org/TR/xpath) - - [XSLT transformations](https://www.w3.org/TR/xslt) - - [DOM Level 1 Core](https://www.w3.org/TR/REC-DOM-Level-1/) - - [DOM Level 2 Core](https://www.w3.org/TR/DOM-Level-2/) See the section [Differences from the W3C specs](#diff) for two cases in which the XML classes differ from the W3C recommendations. - -## Related namespaces - -.NET also provides other namespaces for XML-related operations. For a list, descriptions, and links, see [System.Xml Namespaces](/previous-versions/gg145036(v=vs.110)). - ## Processing XML asynchronously The and classes include a number of asynchronous methods that are based on the asynchronous programming model. These methods can be identified by the string "Async" at the end of their names. With these methods, you can write asynchronous code that's similar to your synchronous code, and you can migrate your existing synchronous code to asynchronous code easily. -- Use the asynchronous methods in apps where there is significant network stream latency. Avoid using the asynchronous APIs for memory stream or local file stream read/write operations. The input stream, , and should support asynchronous operations as well. Otherwise, threads will still be blocked by I/O operations. +- Use the asynchronous methods in apps where there is significant network stream latency. Avoid using the asynchronous APIs for memory stream or local file stream read/write operations. The input stream, , and should support asynchronous operations as well. Otherwise, threads will still be blocked by I/O operations. -- We don't recommend mixing synchronous and asynchronous function calls, because you might forget to use the `await` keyword or use a synchronous API where an asynchronous one is necessary. +- We don't recommend mixing synchronous and asynchronous function calls, because you might forget to use the `await` keyword or use a synchronous API where an asynchronous one is necessary. -- Do not set the or flag to `true` if you don't intend to use an asynchronous method. +- Do not set the or flag to `true` if you don't intend to use an asynchronous method. -- If you forget to specify the `await` keyword when you call an asynchronous method, the results are non-deterministic: You might receive the result you expected or an exception. +- If you forget to specify the `await` keyword when you call an asynchronous method, the results are non-deterministic: You might receive the result you expected or an exception. -- When an object is reading a large text node, it might cache only a partial text value and return the text node, so retrieving the property might be blocked by an I/O operation. Use the method to get the text value in asynchronous mode, or use the method to read a large text block in chunks. +- When an object is reading a large text node, it might cache only a partial text value and return the text node, so retrieving the property might be blocked by an I/O operation. Use the method to get the text value in asynchronous mode, or use the method to read a large text block in chunks. -- When you use an object, call the method before calling to avoid blocking an I/O operation. +- When you use an object, call the method before calling to avoid blocking an I/O operation. ## Differences from the W3C specs @@ -87,15 +76,11 @@ Under the following conditions, the implementation does not satisfy the "Schema Component Constraint: Unique Particle Attribution," which is described in the [Constraints on Model Group Schema Components](https://go.microsoft.com/fwlink/?LinkId=137029) section of the W3C spec. -- One of the elements in the group references another element. - -- The referenced element is a head element of a substitution group. - -- The substitution group contains an element that has the same name as one of the elements in the group. - -- The cardinality of the element that references the substitution group head element and the element with the same name as a substitution group element is not fixed (minOccurs < maxOccurs). - -- The definition of the element that references the substitution group precedes the definition of the element with the same name as a substitution group element. +- One of the elements in the group references another element. +- The referenced element is a head element of a substitution group. +- The substitution group contains an element that has the same name as one of the elements in the group. +- The cardinality of the element that references the substitution group head element and the element with the same name as a substitution group element is not fixed (minOccurs < maxOccurs). +- The definition of the element that references the substitution group precedes the definition of the element with the same name as a substitution group element. For example, in the schema below the content model is ambiguous and should cause a compilation error, but compiles the schema without errors. @@ -184,27 +169,27 @@ The following scenarios are considered to be less vulnerable to denial of service attacks because the classes provide a means of protection from such attacks. -- Parsing text XML data. +- Parsing text XML data. -- Parsing binary XML data if the binary XML data was generated by Microsoft SQL Server. +- Parsing binary XML data if the binary XML data was generated by Microsoft SQL Server. -- Writing XML documents and fragments from data sources to the file system, streams, a , or a . +- Writing XML documents and fragments from data sources to the file system, streams, a , or a . -- Loading documents into the Document Object Model (DOM) object if you are using an object and set to . +- Loading documents into the Document Object Model (DOM) object if you are using an object and set to . -- Navigating the DOM object. +- Navigating the DOM object. The following scenarios are not recommended if you are concerned about denial of service attacks, or if you are working in an untrusted environment. -- DTD processing. +- DTD processing. -- Schema processing. This includes adding an untrusted schema to the schema collection, compiling an untrusted schema, and validating by using an untrusted schema. +- Schema processing. This includes adding an untrusted schema to the schema collection, compiling an untrusted schema, and validating by using an untrusted schema. -- XSLT processing. +- XSLT processing. -- Parsing any arbitrary stream of user supplied binary XML data. +- Parsing any arbitrary stream of user supplied binary XML data. -- DOM operations such as querying, editing, moving sub-trees between documents, and saving DOM objects. +- DOM operations such as querying, editing, moving sub-trees between documents, and saving DOM objects. If you are concerned about denial of service issues or if you are dealing with untrusted sources, do not enable DTD processing. This is disabled by default on objects that the method creates. @@ -223,15 +208,15 @@ When creating an app that uses the class, you should be aware of the following items and their implications: -- XSLT scripting is disabled by default. XSLT scripting should be enabled only if you require script support and you are working in a fully trusted environment. +- XSLT scripting is disabled by default. XSLT scripting should be enabled only if you require script support and you are working in a fully trusted environment. -- The XSLT `document()` function is disabled by default. If you enable the `document()` function, restrict the resources that can be accessed by passing an object to the method. +- The XSLT `document()` function is disabled by default. If you enable the `document()` function, restrict the resources that can be accessed by passing an object to the method. -- Extension objects are enabled by default. If an object that contains extension objects is passed to the method, the extension objects are used. +- Extension objects are enabled by default. If an object that contains extension objects is passed to the method, the extension objects are used. -- XSLT style sheets can include references to other files and embedded script blocks. A malicious user can exploit this by supplying you with data or style sheets that, when executed, can cause your system to process until the computer runs low on resources. +- XSLT style sheets can include references to other files and embedded script blocks. A malicious user can exploit this by supplying you with data or style sheets that, when executed, can cause your system to process until the computer runs low on resources. -- XSLT apps that run in a mixed trust environment can result in style sheet spoofing. For example, a malicious user can load an object with a harmful style sheet and hand it off to another user who subsequently calls the method and executes the transformation. +- XSLT apps that run in a mixed trust environment can result in style sheet spoofing. For example, a malicious user can load an object with a harmful style sheet and hand it off to another user who subsequently calls the method and executes the transformation. These security issues can be mitigated by not enabling scripting or the `document()` function unless the style sheet comes from a trusted source, and by not accepting objects, XSLT style sheets, or XML source data from an untrusted source.