From ccc7279adb750122d72d53b44cd6bb5c0a81b377 Mon Sep 17 00:00:00 2001 From: "apexvss@microsoft.com" Date: Tue, 27 Aug 2024 15:08:30 +0000 Subject: [PATCH 01/11] CI Update Build.Reason:Manual by Min Huang Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=450660&view=results source_repo.branch:mh/workaround source_repo.url:https://apidrop.visualstudio.com/_git/binaries --- xml/FrameworksIndex/net-6.0.xml | 6 - xml/FrameworksIndex/net-7.0.xml | 6 - xml/FrameworksIndex/net-8.0.xml | 6 - xml/FrameworksIndex/net-9.0.xml | 6 - xml/FrameworksIndex/netframework-4.6.2.xml | 8 - xml/FrameworksIndex/netframework-4.7.1.xml | 8 - xml/FrameworksIndex/netframework-4.7.2.xml | 8 - xml/FrameworksIndex/netframework-4.7.xml | 8 - xml/FrameworksIndex/netframework-4.8.1.xml | 8 - xml/FrameworksIndex/netframework-4.8.xml | 8 - xml/FrameworksIndex/netstandard-2.0.xml | 8 - .../CollectionExtensions.xml | 584 ++- .../PersistedAssemblyBuilder.xml | 6 +- xml/System.Reflection/TypeExtensions.xml | 431 +- .../CustomQueryInterfaceMode.xml | 6 +- .../RuntimeEnvironment.xml | 6 +- .../AsymmetricAlgorithm.xml | 4000 ++++++++--------- .../RandomNumberGenerator.xml | 2220 ++++----- .../ServiceDescription.xml | 2 +- .../NetNamedPipeBinding.xml | 2 +- 20 files changed, 3683 insertions(+), 3654 deletions(-) diff --git a/xml/FrameworksIndex/net-6.0.xml b/xml/FrameworksIndex/net-6.0.xml index dd3892873b7..cd0cc8d354d 100644 --- a/xml/FrameworksIndex/net-6.0.xml +++ b/xml/FrameworksIndex/net-6.0.xml @@ -12921,12 +12921,6 @@ - - - - - - diff --git a/xml/FrameworksIndex/net-7.0.xml b/xml/FrameworksIndex/net-7.0.xml index 97c2768d257..e5346f869d5 100644 --- a/xml/FrameworksIndex/net-7.0.xml +++ b/xml/FrameworksIndex/net-7.0.xml @@ -13725,12 +13725,6 @@ - - - - - - diff --git a/xml/FrameworksIndex/net-8.0.xml b/xml/FrameworksIndex/net-8.0.xml index 15ef5788c56..418fa79a9ac 100644 --- a/xml/FrameworksIndex/net-8.0.xml +++ b/xml/FrameworksIndex/net-8.0.xml @@ -15766,12 +15766,6 @@ - - - - - - diff --git a/xml/FrameworksIndex/net-9.0.xml b/xml/FrameworksIndex/net-9.0.xml index eb4a429557d..349c1d14eb0 100644 --- a/xml/FrameworksIndex/net-9.0.xml +++ b/xml/FrameworksIndex/net-9.0.xml @@ -15993,12 +15993,6 @@ - - - - - - diff --git a/xml/FrameworksIndex/netframework-4.6.2.xml b/xml/FrameworksIndex/netframework-4.6.2.xml index d1b3c7f3a22..483b1ee47f8 100644 --- a/xml/FrameworksIndex/netframework-4.6.2.xml +++ b/xml/FrameworksIndex/netframework-4.6.2.xml @@ -25520,14 +25520,6 @@ - - - - - - - - diff --git a/xml/FrameworksIndex/netframework-4.7.1.xml b/xml/FrameworksIndex/netframework-4.7.1.xml index 013301494b2..0aa6b6c5613 100644 --- a/xml/FrameworksIndex/netframework-4.7.1.xml +++ b/xml/FrameworksIndex/netframework-4.7.1.xml @@ -25780,14 +25780,6 @@ - - - - - - - - diff --git a/xml/FrameworksIndex/netframework-4.7.2.xml b/xml/FrameworksIndex/netframework-4.7.2.xml index 44573522b18..ba5ba866e01 100644 --- a/xml/FrameworksIndex/netframework-4.7.2.xml +++ b/xml/FrameworksIndex/netframework-4.7.2.xml @@ -25795,14 +25795,6 @@ - - - - - - - - diff --git a/xml/FrameworksIndex/netframework-4.7.xml b/xml/FrameworksIndex/netframework-4.7.xml index bb85cd392fe..7b03f6ea931 100644 --- a/xml/FrameworksIndex/netframework-4.7.xml +++ b/xml/FrameworksIndex/netframework-4.7.xml @@ -25740,14 +25740,6 @@ - - - - - - - - diff --git a/xml/FrameworksIndex/netframework-4.8.1.xml b/xml/FrameworksIndex/netframework-4.8.1.xml index 97d77164872..2c130f9d9f6 100644 --- a/xml/FrameworksIndex/netframework-4.8.1.xml +++ b/xml/FrameworksIndex/netframework-4.8.1.xml @@ -25796,14 +25796,6 @@ - - - - - - - - diff --git a/xml/FrameworksIndex/netframework-4.8.xml b/xml/FrameworksIndex/netframework-4.8.xml index ffe3f9a0e7a..e08eef759fc 100644 --- a/xml/FrameworksIndex/netframework-4.8.xml +++ b/xml/FrameworksIndex/netframework-4.8.xml @@ -25796,14 +25796,6 @@ - - - - - - - - diff --git a/xml/FrameworksIndex/netstandard-2.0.xml b/xml/FrameworksIndex/netstandard-2.0.xml index 9c99e010f13..7ad28a9b712 100644 --- a/xml/FrameworksIndex/netstandard-2.0.xml +++ b/xml/FrameworksIndex/netstandard-2.0.xml @@ -10641,14 +10641,6 @@ - - - - - - - - diff --git a/xml/System.Collections.Generic/CollectionExtensions.xml b/xml/System.Collections.Generic/CollectionExtensions.xml index cc923918517..eb859075971 100644 --- a/xml/System.Collections.Generic/CollectionExtensions.xml +++ b/xml/System.Collections.Generic/CollectionExtensions.xml @@ -56,12 +56,13 @@ - + + Method System.Collections @@ -92,6 +93,14 @@ [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + [System.Runtime.CompilerServices.ParamCollection] + [<System.Runtime.CompilerServices.ParamCollection>] + + + [System.Runtime.CompilerServices.ScopedRef] + [<System.Runtime.CompilerServices.ScopedRef>] + @@ -105,12 +114,12 @@ - - - - - - + + + + + + Method System.Collections @@ -122,10 +131,17 @@ netstandard - System.Collections.ObjectModel.ReadOnlyCollection<T> + System.Collections.ObjectModel.ReadOnlyCollection<T> - + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + @@ -141,12 +157,12 @@ - - - - - - + + + + + + Method System.Collections @@ -158,11 +174,18 @@ netstandard - System.Collections.ObjectModel.ReadOnlyDictionary<TKey,TValue> + System.Collections.ObjectModel.ReadOnlyDictionary<TKey,TValue> - - + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + @@ -228,223 +251,115 @@ The number of elements in the source is greater than the number of elements that the destination span can contain. - - - - - - - + + + + + + + Method - - Microsoft.Extensions.DependencyModel - 8.0.0.1 - 9.0.0.0 - System.Collections - - - netstandard - - - System.Collections.Generic.IEnumerable<System.String> - - - - - - The source enumeration of . - Gets an enumeration of assets where each asset has an empty runtime. - An enumeration of assets, each with an empty . - To be added. - - is . - - - - - - - - - - Method - - Microsoft.Extensions.DependencyModel - 8.0.0.1 9.0.0.0 - - System.Collections - - - netstandard - - - Microsoft.Extensions.DependencyModel.RuntimeAssetGroup - - - - - - The source enumeration of . - Gets the first with an empty . - The first with an empty , or if none exists. - To be added. - - is . - - - - - - - - - - Method - - Microsoft.Extensions.DependencyModel - 8.0.0.1 - 9.0.0.0 - - - System.Collections - netstandard + + + [System.Runtime.CompilerServices.NullableContext(2)] + [<System.Runtime.CompilerServices.NullableContext(2)>] + + - System.Collections.Generic.IEnumerable<Microsoft.Extensions.DependencyModel.RuntimeFile> - - - - - - The source enumeration of . - Gets an enumeration of where each value has an empty runtime. - An enumeration of , each with an empty . - To be added. - - is . - - - - - - - - - - Method - - Microsoft.Extensions.DependencyModel - 8.0.0.1 - 9.0.0.0 - - - System.Collections - - - netstandard - - - System.Collections.Generic.IEnumerable<System.String> + System.Collections.Generic.HashSet<T>+AlternateLookup<TAlternate> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 1 })>] + + + + + + - - + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + - The source enumeration of . - The string to search for. - Gets an enumeration of assets where each asset's value equals . - An enumeration of assets where each asset's equals . + To be added. + To be added. + To be added. + To be added. + To be added. To be added. - - is . - - - - - - - + + + + + + + Method - - Microsoft.Extensions.DependencyModel - 8.0.0.1 - 9.0.0.0 - System.Collections - - - netstandard - - - System.Collections.Generic.IEnumerable<Microsoft.Extensions.DependencyModel.RuntimeFile> - - - - - - - The source enumeration of . - The string to search for. - Gets an enumeration of where each value's equals . - An enumeration of , where each value's equals . - To be added. - - is or empty. - - - - - - - - - - Method - - Microsoft.Extensions.DependencyModel - 8.0.0.1 9.0.0.0 - - System.Collections - netstandard - Microsoft.Extensions.DependencyModel.RuntimeAssetGroup + System.Collections.Generic.Dictionary<TKey,TValue>+AlternateLookup<TAlternateKey> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 1, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 1, 1 })>] + + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + - - + - The source enumeration of . - The string to search for. - Gets the first where matches . - The first where matches , or if none exists. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. To be added. - - is or empty. - - - - - - + + + + + + Method @@ -462,16 +377,36 @@ netstandard 2.1.0.0 + + + [System.Runtime.CompilerServices.NullableContext(2)] + [<System.Runtime.CompilerServices.NullableContext(2)>] + + - TValue + TValue - - + + - - + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + The type of the keys in the dictionary. @@ -486,12 +421,12 @@ - - - - - - + + + + + + Method System.Collections @@ -509,16 +444,30 @@ 2.1.0.0 - TValue + TValue - - + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + - - - + + + [System.Diagnostics.CodeAnalysis.AllowNull] @@ -541,12 +490,13 @@ - + + Method System.Collections @@ -578,6 +528,14 @@ [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + [System.Runtime.CompilerServices.ParamCollection] + [<System.Runtime.CompilerServices.ParamCollection>] + + + [System.Runtime.CompilerServices.ScopedRef] + [<System.Runtime.CompilerServices.ScopedRef>] + @@ -594,12 +552,12 @@ - - - - - - + + + + + + Method System.Collections @@ -617,18 +575,32 @@ 2.1.0.0 - System.Boolean + System.Boolean - - + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + - - - + + + - + [System.Diagnostics.CodeAnalysis.MaybeNullWhen(false)] [<System.Diagnostics.CodeAnalysis.MaybeNullWhen(false)>] @@ -650,12 +622,12 @@ - - - - - - + + + + + + Method System.Collections @@ -673,16 +645,30 @@ 2.1.0.0 - System.Boolean + System.Boolean - - + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + - - - + + + The type of the keys in the dictionary. @@ -698,5 +684,113 @@ is . + + + + + + + + Method + + System.Collections + 9.0.0.0 + + + netstandard + + + + [System.Runtime.CompilerServices.NullableContext(2)] + [<System.Runtime.CompilerServices.NullableContext(2)>] + + + + System.Boolean + + + + + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 1 })>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Collections + 9.0.0.0 + + + netstandard + + + System.Boolean + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 1, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 1, 1 })>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Reflection.Emit/PersistedAssemblyBuilder.xml b/xml/System.Reflection.Emit/PersistedAssemblyBuilder.xml index cedd9072918..34a88531211 100644 --- a/xml/System.Reflection.Emit/PersistedAssemblyBuilder.xml +++ b/xml/System.Reflection.Emit/PersistedAssemblyBuilder.xml @@ -244,7 +244,8 @@ - to get a copied name; to set get the original name. + + to get a copied name; to set get the original name. Gets the that was specified when the current dynamic assembly was created. The name of the dynamic assembly. To be added. @@ -289,7 +290,8 @@ Gets the module in the current that contains the assembly manifest. To be added. - supports only one module per assembly. + + supports only one module per assembly. diff --git a/xml/System.Reflection/TypeExtensions.xml b/xml/System.Reflection/TypeExtensions.xml index 7f2059054f1..62b2a33b928 100644 --- a/xml/System.Reflection/TypeExtensions.xml +++ b/xml/System.Reflection/TypeExtensions.xml @@ -307,23 +307,38 @@ - - - - - - + + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 - System.Reflection.FieldInfo + System.Reflection.FieldInfo - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)>] + + + + To be added. @@ -334,39 +349,24 @@ - - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Reflection.FieldInfo + System.Reflection.FieldInfo - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)>] - - - - - + + + To be added. @@ -529,23 +529,37 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 - System.Reflection.MemberInfo[] + System.Reflection.MemberInfo[] - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + + + + To be added. @@ -585,22 +599,36 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 - System.Reflection.MemberInfo[] + System.Reflection.MemberInfo[] - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + + + To be added. @@ -637,38 +665,23 @@ - - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Reflection.MethodInfo + System.Reflection.MethodInfo - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)>] - - - - + + To be added. @@ -679,24 +692,39 @@ - - - - - - + + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 - System.Reflection.MethodInfo + System.Reflection.MethodInfo - - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)>] + + + + + To be added. @@ -777,37 +805,23 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Reflection.MethodInfo[] + System.Reflection.MethodInfo[] - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)>] - - - - + + To be added. @@ -818,13 +832,41 @@ - - - - - - - + + + + + + + Method + + System.Reflection.TypeExtensions + 4.1.5.0 + + + System.Type + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + Method System.Reflection.TypeExtensions @@ -838,7 +880,7 @@ 9.0.0.0 - System.Type + System.Type[] @@ -849,52 +891,62 @@ - - + To be added. - To be added. To be added. To be added. To be added. To be added. - - - - - - - + + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 - System.Type[] + System.Reflection.PropertyInfo[] - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + + + To be added. - To be added. To be added. To be added. To be added. - - - - - - + + + + + + Method System.Reflection.TypeExtensions @@ -905,21 +957,24 @@ + To be added. + To be added. To be added. To be added. To be added. - - - - - - - + + + + + + + + Method System.Reflection.TypeExtensions @@ -933,45 +988,18 @@ 9.0.0.0 - System.Reflection.PropertyInfo[] + System.Reflection.PropertyInfo - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Reflection.TypeExtensions - 4.1.5.0 - - - System.Reflection.PropertyInfo - - - - + To be added. @@ -1115,42 +1143,23 @@ - - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Boolean + System.Boolean - - - - - [System.Diagnostics.CodeAnalysis.NotNullWhen(true)] - [<System.Diagnostics.CodeAnalysis.NotNullWhen(true)>] - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - + + To be added. diff --git a/xml/System.Runtime.InteropServices/CustomQueryInterfaceMode.xml b/xml/System.Runtime.InteropServices/CustomQueryInterfaceMode.xml index 6f367972a77..9d33b346cf9 100644 --- a/xml/System.Runtime.InteropServices/CustomQueryInterfaceMode.xml +++ b/xml/System.Runtime.InteropServices/CustomQueryInterfaceMode.xml @@ -102,7 +102,8 @@ 1 - IUnknown::QueryInterface method calls can use the interface. When you use this value, the method overload functions like the overload. + + IUnknown::QueryInterface method calls can use the interface. When you use this value, the method overload functions like the overload. @@ -144,7 +145,8 @@ 0 - IUnknown::QueryInterface method calls should ignore the interface. + + IUnknown::QueryInterface method calls should ignore the interface. diff --git a/xml/System.Runtime.InteropServices/RuntimeEnvironment.xml b/xml/System.Runtime.InteropServices/RuntimeEnvironment.xml index 432dbaadd8f..fc9afa15d23 100644 --- a/xml/System.Runtime.InteropServices/RuntimeEnvironment.xml +++ b/xml/System.Runtime.InteropServices/RuntimeEnvironment.xml @@ -292,7 +292,8 @@ The following table shows the supported combinations for `clsid` and `riid`. ]]> - IUnknown::QueryInterface failure. + + IUnknown::QueryInterface failure. .NET Core and .NET 5+ only: In all cases. @@ -359,7 +360,8 @@ The following table shows the supported combinations for `clsid` and `riid`. ]]> - IUnknown::QueryInterface failure. + + IUnknown::QueryInterface failure. .NET Core and .NET 5+ only: In all cases. diff --git a/xml/System.Security.Cryptography/AsymmetricAlgorithm.xml b/xml/System.Security.Cryptography/AsymmetricAlgorithm.xml index df27df87ffc..f21deedf5b3 100644 --- a/xml/System.Security.Cryptography/AsymmetricAlgorithm.xml +++ b/xml/System.Security.Cryptography/AsymmetricAlgorithm.xml @@ -1,64 +1,64 @@ - - - - - - - - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - - - - - - - - - - System.Object - - - - System.IDisposable - - - - - [System.Runtime.InteropServices.ComVisible(true)] - [<System.Runtime.InteropServices.ComVisible(true)>] - - - - Represents the abstract base class from which all implementations of asymmetric algorithms must inherit. - + + + + + + + + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + + + + + + + + + + System.Object + + + + System.IDisposable + + + + + [System.Runtime.InteropServices.ComVisible(true)] + [<System.Runtime.InteropServices.ComVisible(true)>] + + + + Represents the abstract base class from which all implementations of asymmetric algorithms must inherit. + - - Cryptographic Services - How to: Create a Public/Private Key Pair - - - - - - - - - Constructor - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - Initializes a new instance of the class. - + ]]> + + Cryptographic Services + How to: Create a Public/Private Key Pair + + + + + + + + + Constructor + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + Initializes a new instance of the class. + and classes are the only currently supported implementations. - ]]> - - The implementation of the derived class is not valid. - Cryptographic Services - - - - - - - - - - Method - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography.Primitives - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Void - - - - Releases all resources used by the class. - + ]]> + + The implementation of the derived class is not valid. + Cryptographic Services + + + + + + + + + + Method + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography.Primitives + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Void + + + + Releases all resources used by the class. + - - Cryptographic Services - - - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - Creates a cryptographic object used to perform the asymmetric algorithm. - - - - - - - - - - Method - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography.Primitives - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - [System.Obsolete("The default implementation of this cryptography algorithm is not supported", DiagnosticId="SYSLIB0007", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] - [<System.Obsolete("The default implementation of this cryptography algorithm is not supported", DiagnosticId="SYSLIB0007", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] - - - [System.Obsolete("The default implementation of this cryptography algorithm is not supported.", DiagnosticId="SYSLIB0007", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] - [<System.Obsolete("The default implementation of this cryptography algorithm is not supported.", DiagnosticId="SYSLIB0007", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - [System.Security.SecuritySafeCritical] - [<System.Security.SecuritySafeCritical>] - - - - System.Security.Cryptography.AsymmetricAlgorithm - - - - Creates a default cryptographic object used to perform the asymmetric algorithm. - A new instance, unless the default settings have been changed with the <cryptoClass> element. - + ]]> + + Cryptographic Services + + + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + Creates a cryptographic object used to perform the asymmetric algorithm. + + + + + + + + + + Method + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography.Primitives + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + [System.Obsolete("The default implementation of this cryptography algorithm is not supported", DiagnosticId="SYSLIB0007", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("The default implementation of this cryptography algorithm is not supported", DiagnosticId="SYSLIB0007", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + + + [System.Obsolete("The default implementation of this cryptography algorithm is not supported.", DiagnosticId="SYSLIB0007", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("The default implementation of this cryptography algorithm is not supported.", DiagnosticId="SYSLIB0007", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + [System.Security.SecuritySafeCritical] + [<System.Security.SecuritySafeCritical>] + + + + System.Security.Cryptography.AsymmetricAlgorithm + + + + Creates a default cryptographic object used to perform the asymmetric algorithm. + A new instance, unless the default settings have been changed with the <cryptoClass> element. + - - .NET Core 2.0 - 3.1 and .NET 5 and later: In all cases. - Cryptographic Services - - - - - - - - - - - Method - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography.Primitives - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("The default algorithm implementations might be removed, use strong type references like 'RSA.Create()' instead.")] - [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("The default algorithm implementations might be removed, use strong type references like 'RSA.Create()' instead.")>] - - - [System.Obsolete("Cryptographic factory methods accepting an algorithm name are obsolete. Use the parameterless Create factory method on the algorithm type instead.", DiagnosticId="SYSLIB0045", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] - [<System.Obsolete("Cryptographic factory methods accepting an algorithm name are obsolete. Use the parameterless Create factory method on the algorithm type instead.", DiagnosticId="SYSLIB0045", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - [System.Security.SecuritySafeCritical] - [<System.Security.SecuritySafeCritical>] - - - - System.Security.Cryptography.AsymmetricAlgorithm - - - - - + ]]> + + .NET Core 2.0 - 3.1 and .NET 5 and later: In all cases. + Cryptographic Services + + + + + + + + + + + Method + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography.Primitives + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("The default algorithm implementations might be removed, use strong type references like 'RSA.Create()' instead.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("The default algorithm implementations might be removed, use strong type references like 'RSA.Create()' instead.")>] + + + [System.Obsolete("Cryptographic factory methods accepting an algorithm name are obsolete. Use the parameterless Create factory method on the algorithm type instead.", DiagnosticId="SYSLIB0045", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("Cryptographic factory methods accepting an algorithm name are obsolete. Use the parameterless Create factory method on the algorithm type instead.", DiagnosticId="SYSLIB0045", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + [System.Security.SecuritySafeCritical] + [<System.Security.SecuritySafeCritical>] + + + + System.Security.Cryptography.AsymmetricAlgorithm + + + + + The asymmetric algorithm implementation to use. The following table shows the valid values for the parameter and the algorithms they map to. Parameter value @@ -391,10 +391,10 @@ This method is obsolete in .NET 5 and later versions. System.Security.Cryptography.ECDiffieHellmanCng - - Creates an instance of the specified implementation of an asymmetric algorithm. - A new instance of the specified asymmetric algorithm implementation. - + + Creates an instance of the specified implementation of an asymmetric algorithm. + A new instance of the specified asymmetric algorithm implementation. + - - Cryptographic Services - - - - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - - - Releases all resources used by the current instance of the class. - - - - - - - - - - Method - - M:System.IDisposable.Dispose - - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Void - - - - Releases all resources used by the current instance of the class. - + ]]> + + Cryptographic Services + + + + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + + + Releases all resources used by the current instance of the class. + + + + + + + + + + Method + + M:System.IDisposable.Dispose + + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Void + + + + Releases all resources used by the current instance of the class. + [!NOTE] > Always call `Dispose` before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. - ]]> - - - - - - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Void - - - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the class and optionally releases the managed resources. - + ]]> + + + + + + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Void + + + + + + + to release both managed and unmanaged resources; to release only unmanaged resources. + Releases the unmanaged resources used by the class and optionally releases the managed resources. + references. This method invokes the `Dispose()` method of each referenced object. - ]]> - - - + ]]> + + + can be called multiple times by other objects. When overriding , be careful not to reference objects that have been previously disposed in an earlier call to . For more information about how to implement , see Implementing a Dispose Method. - For more information about and , see Cleaning Up Unmanaged Resources. - - Cryptographic Services - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Byte[] - - - - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - - - - - 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. - Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a byte-based password. - A byte array containing the PKCS#8 EncryptedPrivateKeyInfo representation of this key. - + For more information about and , see Cleaning Up Unmanaged Resources. + + Cryptographic Services + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Byte[] + + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + + + + + 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. + Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a byte-based password. + A byte array containing the PKCS#8 EncryptedPrivateKeyInfo representation of this key. + - + ]]> + The key could not be exported. -or- indicates that should be used, which requires -based passwords. - - - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Byte[] - - - - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - - - - - The password to use when encrypting the key material. - The password-based encryption (PBE) parameters to use when encrypting the key material. - Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a char-based password. - A byte array containing the PKCS#8 EncryptedPrivateKeyInfo representation of this key. - + + + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Byte[] + + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + + + + + The password to use when encrypting the key material. + The password-based encryption (PBE) parameters to use when encrypting the key material. + Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a char-based password. + A byte array containing the PKCS#8 EncryptedPrivateKeyInfo representation of this key. + - - The key could not be exported. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - 9.0.0.0 - - - System.Security.Cryptography.Primitives - - - netstandard - - - mscorlib - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.String - - - - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - - - - - 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. - Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a byte-based password, PEM encoded. - A string containing the PEM-encoded PKCS#8 EncryptedPrivateKeyInfo. - + ]]> + + The key could not be exported. + + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + 9.0.0.0 + + + System.Security.Cryptography.Primitives + + + netstandard + + + mscorlib + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.String + + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + + + + + 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. + Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a byte-based password, PEM encoded. + A string containing the PEM-encoded PKCS#8 EncryptedPrivateKeyInfo. + A PEM-encoded PKCS#8 EncryptedPrivateKeyInfo will begin with -----BEGIN ENCRYPTED PRIVATE KEY----- and end with -----END ENCRYPTED PRIVATE KEY-----, with the base64 encoded DER contents of the key between the PEM boundaries. - + The PEM is encoded according to the IETF RFC 7468 "strict" encoding rules. - - + + An implementation for or - has not been provided. - The key could not be exported. - - - - - - - - - - Method - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Security.Cryptography.Primitives - - - netstandard - - - mscorlib - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.String - - - - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - - - - - The password to use when encrypting the key material. - The password-based encryption (PBE) parameters to use when encrypting the key material. - Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a char-based password, PEM encoded. - A string containing the PEM-encoded PKCS#8 EncryptedPrivateKeyInfo. - + has not been provided. + The key could not be exported. + + + + + + + + + + Method + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Security.Cryptography.Primitives + + + netstandard + + + mscorlib + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.String + + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + + + + + The password to use when encrypting the key material. + The password-based encryption (PBE) parameters to use when encrypting the key material. + Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a char-based password, PEM encoded. + A string containing the PEM-encoded PKCS#8 EncryptedPrivateKeyInfo. + - + ]]> + An implementation for or - has not been provided. - The key could not be exported. - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Byte[] - - - - Exports the current key in the PKCS#8 PrivateKeyInfo format. - A byte array containing the PKCS#8 PrivateKeyInfo representation of this key. - To be added. - The key could not be exported. - - - - - - - - - - - - Method - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Security.Cryptography.Primitives - - - netstandard - - - mscorlib - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.String - - - - Exports the current key in the PKCS#8 PrivateKeyInfo format, PEM encoded. - A string containing the PEM-encoded PKCS#8 PrivateKeyInfo. - + has not been provided. + The key could not be exported. + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Byte[] + + + + Exports the current key in the PKCS#8 PrivateKeyInfo format. + A byte array containing the PKCS#8 PrivateKeyInfo representation of this key. + To be added. + The key could not be exported. + + + + + + + + + + + + Method + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Security.Cryptography.Primitives + + + netstandard + + + mscorlib + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.String + + + + Exports the current key in the PKCS#8 PrivateKeyInfo format, PEM encoded. + A string containing the PEM-encoded PKCS#8 PrivateKeyInfo. + - + ]]> + An implementation for or - has not been provided. - The key could not be exported. - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Byte[] - - - - Exports the public-key portion of the current key in the X.509 SubjectPublicKeyInfo format. - A byte array containing the X.509 SubjectPublicKeyInfo representation of the public-key portion of this key. - To be added. - - - - - - - - - - - Method - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Security.Cryptography.Primitives - - - netstandard - - - mscorlib - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.String - - - - Exports the public-key portion of the current key in the X.509 SubjectPublicKeyInfo format, PEM encoded. - A string containing the PEM-encoded X.509 SubjectPublicKeyInfo. - + has not been provided. + The key could not be exported. + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Byte[] + + + + Exports the public-key portion of the current key in the X.509 SubjectPublicKeyInfo format. + A byte array containing the X.509 SubjectPublicKeyInfo representation of the public-key portion of this key. + To be added. + + + + + + + + + + + Method + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Security.Cryptography.Primitives + + + netstandard + + + mscorlib + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.String + + + + Exports the public-key portion of the current key in the X.509 SubjectPublicKeyInfo format, PEM encoded. + A string containing the PEM-encoded X.509 SubjectPublicKeyInfo. + - + ]]> + An implementation for or - has not been provided. - The key could not be exported. - - - - - - - - - - - - - - Method - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography.Primitives - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Void - - - - - - The XML string to use to reconstruct the object. - When overridden in a derived class, reconstructs an object from an XML string. Otherwise, throws a . - + has not been provided. + The key could not be exported. + + + + + + + + + + + + + + Method + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography.Primitives + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Void + + + + + + The XML string to use to reconstruct the object. + When overridden in a derived class, reconstructs an object from an XML string. Otherwise, throws a . + - - Cryptographic Services - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Void - - - - - - - - The bytes to use as a password when decrypting the key material. - The bytes of a PKCS#8 EncryptedPrivateKeyInfo structure in the ASN.1-BER encoding. - When this method returns, contains a value that indicates the number of bytes read from . This parameter is treated as uninitialized. - When overridden in a derived class, imports the public/private keypair from a PKCS#8 EncryptedPrivateKeyInfo structure after decrypting with a byte-based password, replacing the keys for this object. - + ]]> + + Cryptographic Services + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Void + + + + + + + + The bytes to use as a password when decrypting the key material. + The bytes of a PKCS#8 EncryptedPrivateKeyInfo structure in the ASN.1-BER encoding. + When this method returns, contains a value that indicates the number of bytes read from . This parameter is treated as uninitialized. + When overridden in a derived class, imports the public/private keypair from a PKCS#8 EncryptedPrivateKeyInfo structure after decrypting with a byte-based password, replacing the keys for this object. + throws a by default. - ]]> - + ]]> + The password is incorrect. -or- @@ -1143,49 +1143,49 @@ The contents of represent the key in a format that is -or- The algorithm-specific key import failed. - - A derived type has not overriden this member. - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Void - - - - - - - - The password to use for decrypting the key material. - The bytes of a PKCS#8 EncryptedPrivateKeyInfo structure in the ASN.1-BER encoding. - When this method returns, contains a value that indicates the number of bytes read from . This parameter is treated as uninitialized. - When overridden in a derived class, imports the public/private keypair from a PKCS#8 EncryptedPrivateKeyInfo structure after decrypting with a char-based password, replacing the keys for this object. - + + A derived type has not overriden this member. + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Void + + + + + + + + The password to use for decrypting the key material. + The bytes of a PKCS#8 EncryptedPrivateKeyInfo structure in the ASN.1-BER encoding. + When this method returns, contains a value that indicates the number of bytes read from . This parameter is treated as uninitialized. + When overridden in a derived class, imports the public/private keypair from a PKCS#8 EncryptedPrivateKeyInfo structure after decrypting with a char-based password, replacing the keys for this object. + throws a by default. - ]]> - + ]]> + The password is incorrect. -or- @@ -1215,60 +1215,60 @@ The contents of represent the key in a format that is -or- The algorithm-specific key import failed. - - A derived type has not overriden this member. - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 5.0.0.0 - 6.0.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - netstandard - - - System.Void - - - - - - - The PEM text of the encrypted key to import. - The bytes to use as a password when decrypting the key material. - When overridden in a derived class, imports an encrypted RFC 7468 PEM-encoded key, replacing the keys for this object. - + + A derived type has not overriden this member. + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 5.0.0.0 + 6.0.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + netstandard + + + System.Void + + + + + + + The PEM text of the encrypted key to import. + The bytes to use as a password when decrypting the key material. + When overridden in a derived class, imports an encrypted RFC 7468 PEM-encoded key, replacing the keys for this object. + . - ]]> - - A derived type has not overridden this member. - + ]]> + + A derived type has not overridden this member. + does not contain a PEM-encoded key with a recognized label. -or- contains multiple PEM-encoded keys with a recognized label. - + The password is incorrect. @@ -1292,59 +1292,59 @@ The base-64 decoded contents of the PEM text from -or- The algorithm-specific key import failed. - - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 5.0.0.0 - 6.0.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - netstandard - - - System.Void - - - - - - - The PEM text of the encrypted key to import. - The password to use for decrypting the key material. - When overridden in a derived class, imports an encrypted RFC 7468 PEM-encoded key, replacing the keys for this object. - + + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 5.0.0.0 + 6.0.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + netstandard + + + System.Void + + + + + + + The PEM text of the encrypted key to import. + The password to use for decrypting the key material. + When overridden in a derived class, imports an encrypted RFC 7468 PEM-encoded key, replacing the keys for this object. + . - ]]> - - A derived type has not overridden this member. - + ]]> + + A derived type has not overridden this member. + does not contain a PEM-encoded key with a recognized label. -or- contains multiple PEM-encoded keys with a recognized label. - + The password is incorrect. @@ -1368,51 +1368,51 @@ The base-64 decoded contents of the PEM text from -or- The algorithm-specific key import failed. - - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 5.0.0.0 - 6.0.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - netstandard - - - System.Void - - - - - - The text of the PEM key to import. - When overridden in a derived class, imports an RFC 7468 textually encoded key, replacing the keys for this object. - + + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 5.0.0.0 + 6.0.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + netstandard + + + System.Void + + + + + + The text of the PEM key to import. + When overridden in a derived class, imports an RFC 7468 textually encoded key, replacing the keys for this object. + . - ]]> - - A derived type has not overridden this member. - + ]]> + + A derived type has not overridden this member. + does not contain a PEM-encoded key with a recognized label. -or- @@ -1422,46 +1422,46 @@ Because each algorithm may have algorithm-specific PEM labels, the default behav -or- contains an encrypted PEM-encoded key. - - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Void - - - - - - - The bytes of a PKCS#8 PrivateKeyInfo structure in the ASN.1-BER encoding. - When this method returns, contains a value that indicates the number of bytes read from . This parameter is treated as uninitialized. - When overriden in a derived class, imports the public/private keypair from a PKCS#8 PrivateKeyInfo structure after decryption, replacing the keys for this object. - + + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Void + + + + + + + The bytes of a PKCS#8 PrivateKeyInfo structure in the ASN.1-BER encoding. + When this method returns, contains a value that indicates the number of bytes read from . This parameter is treated as uninitialized. + When overriden in a derived class, imports the public/private keypair from a PKCS#8 PrivateKeyInfo structure after decryption, replacing the keys for this object. + throws a by default. - ]]> - + ]]> + The contents of do not represent an ASN.1-BER-encoded PKCS#8 PrivateKeyInfo structure. -or- @@ -1485,47 +1485,47 @@ The contents of represent the key in a format that is -or- The algorithm-specific key import failed. - - A derived type has not overriden this member. - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Void - - - - - - - The bytes of an X.509 SubjectPublicKeyInfo structure in the ASN.1-DER encoding. - When this method returns, contains a value that indicates the number of bytes read from . This parameter is treated as uninitialized. - When overriden in a derived class, imports the public key from an X.509 SubjectPublicKeyInfo structure after decryption, replacing the keys for this object. - + + A derived type has not overriden this member. + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Void + + + + + + + The bytes of an X.509 SubjectPublicKeyInfo structure in the ASN.1-DER encoding. + When this method returns, contains a value that indicates the number of bytes read from . This parameter is treated as uninitialized. + When overriden in a derived class, imports the public key from an X.509 SubjectPublicKeyInfo structure after decryption, replacing the keys for this object. + throws a by default. - ]]> - + ]]> + The contents of do not represent an ASN.1-DER-encoded X.509 SubjectPublicKeyInfo structure. -or- @@ -1548,65 +1548,65 @@ The contents of represent the key in a format that is -or- The algorithm-specific key import failed. - - A derived type has not overriden this member. - - - - - - - - - - - - - - Property - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography.Primitives - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - [get: System.Runtime.CompilerServices.NullableContext(2)] - [<get: System.Runtime.CompilerServices.NullableContext(2)>] - - - - System.String - - - When overridden in a derived class, gets the name of the key exchange algorithm. Otherwise, throws an . - The name of the key exchange algorithm. - + + A derived type has not overriden this member. + + + + + + + + + + + + + + Property + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography.Primitives + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + [get: System.Runtime.CompilerServices.NullableContext(2)] + [<get: System.Runtime.CompilerServices.NullableContext(2)>] + + + + System.String + + + When overridden in a derived class, gets the name of the key exchange algorithm. Otherwise, throws an . + The name of the key exchange algorithm. + - - Cryptographic Services - - - - - - - - - - Property - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Int32 - - - Gets or sets the size, in bits, of the key modulus used by the asymmetric algorithm. - The size, in bits, of the key modulus used by the asymmetric algorithm. - + ]]> + + Cryptographic Services + + + + + + + + + + Property + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Int32 + + + Gets or sets the size, in bits, of the key modulus used by the asymmetric algorithm. + The size, in bits, of the key modulus used by the asymmetric algorithm. + - - The key modulus size is invalid. - Cryptographic Services - - - - - - - - - - Field - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Int32 - - - Represents the size, in bits, of the key modulus used by the asymmetric algorithm. - + ]]> + + The key modulus size is invalid. + Cryptographic Services + + + + + + + + + + Field + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Int32 + + + Represents the size, in bits, of the key modulus used by the asymmetric algorithm. + property. - ]]> - - Cryptographic Services - - - - - - - - - - Property - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - [get: System.Runtime.CompilerServices.NullableContext(1)] - [<get: System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Security.Cryptography.KeySizes[] - - - Gets the key sizes that are supported by the asymmetric algorithm. - An array that contains the key sizes supported by the asymmetric algorithm. - + ]]> + + Cryptographic Services + + + + + + + + + + Property + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + [get: System.Runtime.CompilerServices.NullableContext(1)] + [<get: System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Security.Cryptography.KeySizes[] + + + Gets the key sizes that are supported by the asymmetric algorithm. + An array that contains the key sizes supported by the asymmetric algorithm. + - - Cryptographic Services - - - - - - - - - - Field - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - [System.Diagnostics.CodeAnalysis.MaybeNull] - [<System.Diagnostics.CodeAnalysis.MaybeNull>] - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - System.Security.Cryptography.KeySizes[] - - - Specifies the key sizes that are supported by the asymmetric algorithm. - + ]]> + + Cryptographic Services + + + + + + + + + + Field + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.MaybeNull] + [<System.Diagnostics.CodeAnalysis.MaybeNull>] + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + System.Security.Cryptography.KeySizes[] + + + Specifies the key sizes that are supported by the asymmetric algorithm. + property. - ]]> - - Cryptographic Services - - - - - - - - - - - - - - Property - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography.Primitives - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - [get: System.Runtime.CompilerServices.NullableContext(2)] - [<get: System.Runtime.CompilerServices.NullableContext(2)>] - - - - System.String - - - When implemented in a derived class, gets the name of the signature algorithm. Otherwise, always throws a . - The name of the signature algorithm. - + ]]> + + Cryptographic Services + + + + + + + + + + + + + + Property + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography.Primitives + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + [get: System.Runtime.CompilerServices.NullableContext(2)] + [<get: System.Runtime.CompilerServices.NullableContext(2)>] + + + + System.String + + + When implemented in a derived class, gets the name of the signature algorithm. Otherwise, always throws a . + The name of the signature algorithm. + - - Cryptographic Services - - - - - - - - - - Method - - M:System.IDisposable.Dispose - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - - - System.Security.Cryptography.Primitives - - - netstandard - - - System.Security.Cryptography - - - System.Void - - - - For a description of this member, see . - + ]]> + + Cryptographic Services + + + + + + + + + + Method + + M:System.IDisposable.Dispose + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + + + System.Security.Cryptography.Primitives + + + netstandard + + + System.Security.Cryptography + + + System.Void + + + + For a description of this member, see . + instance is cast to an interface. -]]> - - - Cryptographic Services - - - - - - - - - - - - - - Method - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography.Primitives - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.String - - - - - - - to include private parameters; otherwise, . - When overridden in a derived class, creates and returns an XML string representation of the current object. Otherwise, throws a . - An XML string encoding of the current object. - +]]> + + + Cryptographic Services + + + + + + + + + + + + + + Method + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography.Primitives + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.String + + + + + + + to include private parameters; otherwise, . + When overridden in a derived class, creates and returns an XML string representation of the current object. Otherwise, throws a . + An XML string encoding of the current object. + - - Cryptographic Services - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Boolean - - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - 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. - The byte span to receive the PKCS#8 EncryptedPrivateKeyInfo data. - When this method returns, contains a value that indicates the number of bytes written to . This parameter is treated as uninitialized. - When overridden in a derived class, attempts to export the current key in the PKCS#8 EncryptedPrivateKeyInfo format into a provided buffer, using a byte-based password. - - if is big enough to receive the output; otherwise, . - + ]]> + + Cryptographic Services + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Boolean + + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + 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. + The byte span to receive the PKCS#8 EncryptedPrivateKeyInfo data. + When this method returns, contains a value that indicates the number of bytes written to . This parameter is treated as uninitialized. + When overridden in a derived class, attempts to export the current key in the PKCS#8 EncryptedPrivateKeyInfo format into a provided buffer, using a byte-based password. + + if is big enough to receive the output; otherwise, . + throws a by default. - ]]> - + ]]> + The key could not be exported. -or- indicates that should be used, which requires -based passwords. - - A derived type has not overriden this member. - - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Boolean - - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - The password to use when encrypting the key material. - The password-based encryption (PBE) parameters to use when encrypting the key material. - The byte span to receive the PKCS#8 EncryptedPrivateKeyInfo data. - When this method returns, contains a value that indicates the number of bytes written to . This parameter is treated as uninitialized. - When overriden in a derived class, attempts to export the current key in the PKCS#8 EncryptedPrivateKeyInfo format into a provided buffer, using a char-based password. - - if is big enough to receive the output; otherwise, . - + + A derived type has not overriden this member. + + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Boolean + + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + The password to use when encrypting the key material. + The password-based encryption (PBE) parameters to use when encrypting the key material. + The byte span to receive the PKCS#8 EncryptedPrivateKeyInfo data. + When this method returns, contains a value that indicates the number of bytes written to . This parameter is treated as uninitialized. + When overriden in a derived class, attempts to export the current key in the PKCS#8 EncryptedPrivateKeyInfo format into a provided buffer, using a char-based password. + + if is big enough to receive the output; otherwise, . + throws a by default. - ]]> - - The key could not be exported. - A derived type has not overriden this member. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - 9.0.0.0 - - - System.Security.Cryptography.Primitives - - - netstandard - - - mscorlib - - - System.Boolean - - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - 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. - The character span to receive the PEM-encoded PKCS#8 EncryptedPrivateKeyInfo data. - When this method returns, contains a value that indicates the number of characters written to . This parameter is treated as uninitialized. - Attempts to export the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a byte-based password, PEM encoded. - - if is big enough to receive the output; otherwise, . - + ]]> + + The key could not be exported. + A derived type has not overriden this member. + + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + 9.0.0.0 + + + System.Security.Cryptography.Primitives + + + netstandard + + + mscorlib + + + System.Boolean + + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + 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. + The character span to receive the PEM-encoded PKCS#8 EncryptedPrivateKeyInfo data. + When this method returns, contains a value that indicates the number of characters written to . This parameter is treated as uninitialized. + Attempts to export the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a byte-based password, PEM encoded. + + if is big enough to receive the output; otherwise, . + A PEM-encoded PKCS#8 EncryptedPrivateKeyInfo will begin with -----BEGIN ENCRYPTED PRIVATE KEY----- and end with -----END ENCRYPTED PRIVATE KEY-----, with the base64 encoded DER contents of the key between the PEM boundaries. - + The PEM is encoded according to the IETF RFC 7468 "strict" encoding rules. - - + + An implementation for - has not been provided. - The key could not be exported. - - - - - - - - - - Method - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Security.Cryptography.Primitives - - - netstandard - - - mscorlib - - - System.Boolean - - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - The password to use when encrypting the key material. - The password-based encryption (PBE) parameters to use when encrypting the key material. - The character span to receive the PEM-encoded PKCS#8 EncryptedPrivateKeyInfo data. - When this method returns, contains a value that indicates the number of characters written to . This parameter is treated as uninitialized. - Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a char-based password, PEM encoded. - - if is big enough to receive the output; otherwise, . - + has not been provided. + The key could not be exported. + + + + + + + + + + Method + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Security.Cryptography.Primitives + + + netstandard + + + mscorlib + + + System.Boolean + + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + The password to use when encrypting the key material. + The password-based encryption (PBE) parameters to use when encrypting the key material. + The character span to receive the PEM-encoded PKCS#8 EncryptedPrivateKeyInfo data. + When this method returns, contains a value that indicates the number of characters written to . This parameter is treated as uninitialized. + Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a char-based password, PEM encoded. + + if is big enough to receive the output; otherwise, . + - + ]]> + An implementation for - has not been provided. - The key could not be exported. - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Boolean - - - - - - - The byte span to receive the PKCS#8 PrivateKeyInfo data. - When this method returns, contains a value that indicates the number of bytes written to . This parameter is treated as uninitialized. - When overridden in a derived class, attempts to export the current key in the PKCS#8 PrivateKeyInfo format into a provided buffer. - - if is big enough to receive the output; otherwise, . - + has not been provided. + The key could not be exported. + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Boolean + + + + + + + The byte span to receive the PKCS#8 PrivateKeyInfo data. + When this method returns, contains a value that indicates the number of bytes written to . This parameter is treated as uninitialized. + When overridden in a derived class, attempts to export the current key in the PKCS#8 PrivateKeyInfo format into a provided buffer. + + if is big enough to receive the output; otherwise, . + throws a by default. - ]]> - - The key could not be exported. - A derived type has not overriden this member. - - - - - - - - - - - Method - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Security.Cryptography.Primitives - - - netstandard - - - mscorlib - - - System.Boolean - - - - - - - The character span to receive the PEM-encoded PKCS#8 PrivateKeyInfo data. - When this method returns, contains a value that indicates the number of characters written to . This parameter is treated as uninitialized. - Attempts to export the current key in the PEM-encoded PKCS#8 PrivateKeyInfo format into a provided buffer. - - if is big enough to receive the output; otherwise, . - + ]]> + + The key could not be exported. + A derived type has not overriden this member. + + + + + + + + + + + Method + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Security.Cryptography.Primitives + + + netstandard + + + mscorlib + + + System.Boolean + + + + + + + The character span to receive the PEM-encoded PKCS#8 PrivateKeyInfo data. + When this method returns, contains a value that indicates the number of characters written to . This parameter is treated as uninitialized. + Attempts to export the current key in the PEM-encoded PKCS#8 PrivateKeyInfo format into a provided buffer. + + if is big enough to receive the output; otherwise, . + - + ]]> + An implementation for - has not been provided. - The key could not be exported. - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Boolean - - - - - - - The byte span to receive the X.509 SubjectPublicKeyInfo data. - When this method returns, contains a value that indicates the number of bytes written to . This parameter is treated as uninitialized. - When overridden in a derived class, attempts to export the current key in the X.509 SubjectPublicKeyInfo format into a provided buffer. - - if is big enough to receive the output; otherwise, . - + has not been provided. + The key could not be exported. + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Boolean + + + + + + + The byte span to receive the X.509 SubjectPublicKeyInfo data. + When this method returns, contains a value that indicates the number of bytes written to . This parameter is treated as uninitialized. + When overridden in a derived class, attempts to export the current key in the X.509 SubjectPublicKeyInfo format into a provided buffer. + + if is big enough to receive the output; otherwise, . + throws a by default. - ]]> - - The key could not be exported. - A derived type has not overriden this member. - - - - - - - - - - - Method - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Security.Cryptography.Primitives - - - netstandard - - - mscorlib - - - System.Boolean - - - - - - - The character span to receive the PEM-encoded X.509 SubjectPublicKeyInfo data. - When this method returns, contains a value that indicates the number of characters written to . This parameter is treated as uninitialized. - Attempts to export the current key in the PEM-encoded X.509 SubjectPublicKeyInfo format into a provided buffer. - - if is big enough to receive the output; otherwise, . - + ]]> + + The key could not be exported. + A derived type has not overriden this member. + + + + + + + + + + + Method + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Security.Cryptography.Primitives + + + netstandard + + + mscorlib + + + System.Boolean + + + + + + + The character span to receive the PEM-encoded X.509 SubjectPublicKeyInfo data. + When this method returns, contains a value that indicates the number of characters written to . This parameter is treated as uninitialized. + Attempts to export the current key in the PEM-encoded X.509 SubjectPublicKeyInfo format into a provided buffer. + + if is big enough to receive the output; otherwise, . + - + ]]> + An implementation for - has not been provided. - The key could not be exported. - - - - + has not been provided. + The key could not be exported. + + + + diff --git a/xml/System.Security.Cryptography/RandomNumberGenerator.xml b/xml/System.Security.Cryptography/RandomNumberGenerator.xml index 85e8c21d824..6c6bf0798df 100644 --- a/xml/System.Security.Cryptography/RandomNumberGenerator.xml +++ b/xml/System.Security.Cryptography/RandomNumberGenerator.xml @@ -1,79 +1,79 @@ - - - - - - - - - - - - - - System.Security.Cryptography.Algorithms - 4.0.0.0 - 4.1.0.0 - 4.2.0.0 - 4.3.0.0 - 4.3.1.0 - 4.3.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - - - - - - - - - - System.Object - - - - System.IDisposable - - - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - [System.Runtime.InteropServices.ComVisible(true)] - [<System.Runtime.InteropServices.ComVisible(true)>] - - - - Provides functionality for generating random values. - + + + + + + + + + + + + + + System.Security.Cryptography.Algorithms + 4.0.0.0 + 4.1.0.0 + 4.2.0.0 + 4.3.0.0 + 4.3.1.0 + 4.3.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + + + + + + + + + + System.Object + + + + System.IDisposable + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + [System.Runtime.InteropServices.ComVisible(true)] + [<System.Runtime.InteropServices.ComVisible(true)>] + + + + Provides functionality for generating random values. + - - Cryptographic Services - - - - - - - - - - - - - Constructor - - System.Security.Cryptography.Algorithms - 4.0.0.0 - 4.1.0.0 - 4.2.0.0 - 4.3.0.0 - 4.3.1.0 - 4.3.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - Initializes a new instance of . - + ]]> + + Cryptographic Services + + + + + + + + + + + + + Constructor + + System.Security.Cryptography.Algorithms + 4.0.0.0 + 4.1.0.0 + 4.2.0.0 + 4.3.0.0 + 4.3.1.0 + 4.3.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + Initializes a new instance of . + . - ]]> - - Cryptographic Services - - - - - System.Security.Cryptography.Algorithms - 4.0.0.0 - 4.1.0.0 - 4.2.0.0 - 4.3.0.0 - - - Creates an instance of an implementation of a cryptographic random number generator. - - - - - - - - - - Method - - System.Security.Cryptography.Algorithms - 4.0.0.0 - 4.1.0.0 - 4.2.0.0 - 4.3.0.0 - 4.3.1.0 - 4.3.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - [System.Security.SecuritySafeCritical] - [<System.Security.SecuritySafeCritical>] - - - - System.Security.Cryptography.RandomNumberGenerator - - - - Creates an instance of the default implementation of a cryptographic random number generator that can be used to generate random data. - A new instance of a cryptographic random number generator. - To be added. - Cryptographic Services - - - - - - - - - - - Method - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography.Algorithms - 4.3.0.0 - 4.3.1.0 - 4.3.2.0 - 5.0.0.0 - 6.0.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - - [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("The default algorithm implementations might be removed, use strong type references like 'RSA.Create()' instead.")] - [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("The default algorithm implementations might be removed, use strong type references like 'RSA.Create()' instead.")>] - - - [System.Obsolete("Cryptographic factory methods accepting an algorithm name are obsolete. Use the parameterless Create factory method on the algorithm type instead.", DiagnosticId="SYSLIB0045", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] - [<System.Obsolete("Cryptographic factory methods accepting an algorithm name are obsolete. Use the parameterless Create factory method on the algorithm type instead.", DiagnosticId="SYSLIB0045", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] - - - [System.Security.SecuritySafeCritical] - [<System.Security.SecuritySafeCritical>] - - - - System.Security.Cryptography.RandomNumberGenerator - - - - - - The name of the random number generator implementation to use. - Creates an instance of the specified implementation of a cryptographic random number generator. - A new instance of a cryptographic random number generator. - To be added. - Cryptographic Services - - - - - System.Security.Cryptography.Algorithms - 4.0.0.0 - 4.1.0.0 - 4.2.0.0 - 4.3.0.0 - - - When overridden in a derived class, releases the unmanaged resources used by the current instance of the class. - - - - - - - - - - Method - - M:System.IDisposable.Dispose - - - System.Security.Cryptography.Algorithms - 4.0.0.0 - 4.1.0.0 - 4.2.0.0 - 4.3.0.0 - 4.3.1.0 - 4.3.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Void - - - - When overridden in a derived class, releases all resources used by the current instance of the class. - + ]]> + + Cryptographic Services + + + + + System.Security.Cryptography.Algorithms + 4.0.0.0 + 4.1.0.0 + 4.2.0.0 + 4.3.0.0 + + + Creates an instance of an implementation of a cryptographic random number generator. + + + + + + + + + + Method + + System.Security.Cryptography.Algorithms + 4.0.0.0 + 4.1.0.0 + 4.2.0.0 + 4.3.0.0 + 4.3.1.0 + 4.3.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + [System.Security.SecuritySafeCritical] + [<System.Security.SecuritySafeCritical>] + + + + System.Security.Cryptography.RandomNumberGenerator + + + + Creates an instance of the default implementation of a cryptographic random number generator that can be used to generate random data. + A new instance of a cryptographic random number generator. + To be added. + Cryptographic Services + + + + + + + + + + + Method + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography.Algorithms + 4.3.0.0 + 4.3.1.0 + 4.3.2.0 + 5.0.0.0 + 6.0.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("The default algorithm implementations might be removed, use strong type references like 'RSA.Create()' instead.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("The default algorithm implementations might be removed, use strong type references like 'RSA.Create()' instead.")>] + + + [System.Obsolete("Cryptographic factory methods accepting an algorithm name are obsolete. Use the parameterless Create factory method on the algorithm type instead.", DiagnosticId="SYSLIB0045", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("Cryptographic factory methods accepting an algorithm name are obsolete. Use the parameterless Create factory method on the algorithm type instead.", DiagnosticId="SYSLIB0045", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + + + [System.Security.SecuritySafeCritical] + [<System.Security.SecuritySafeCritical>] + + + + System.Security.Cryptography.RandomNumberGenerator + + + + + + The name of the random number generator implementation to use. + Creates an instance of the specified implementation of a cryptographic random number generator. + A new instance of a cryptographic random number generator. + To be added. + Cryptographic Services + + + + + System.Security.Cryptography.Algorithms + 4.0.0.0 + 4.1.0.0 + 4.2.0.0 + 4.3.0.0 + + + When overridden in a derived class, releases the unmanaged resources used by the current instance of the class. + + + + + + + + + + Method + + M:System.IDisposable.Dispose + + + System.Security.Cryptography.Algorithms + 4.0.0.0 + 4.1.0.0 + 4.2.0.0 + 4.3.0.0 + 4.3.1.0 + 4.3.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Void + + + + When overridden in a derived class, releases all resources used by the current instance of the class. + [!NOTE] > Always call `Dispose` before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. - ]]> - - - - - - - - - - - Method - - System.Security.Cryptography.Algorithms - 4.0.0.0 - 4.1.0.0 - 4.2.0.0 - 4.3.0.0 - 4.3.1.0 - 4.3.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Void - - - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - When overridden in a derived class, releases the unmanaged resources used by the and optionally releases the managed resources. - + ]]> + + + + + + + + + + + Method + + System.Security.Cryptography.Algorithms + 4.0.0.0 + 4.1.0.0 + 4.2.0.0 + 4.3.0.0 + 4.3.1.0 + 4.3.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Void + + + + + + + to release both managed and unmanaged resources; to release only unmanaged resources. + When overridden in a derived class, releases the unmanaged resources used by the and optionally releases the managed resources. + references. This method invokes the `Dispose()` method of each referenced object. - ]]> - - - + ]]> + + + can be called multiple times by other objects. When overriding , be careful not to reference objects that have been previously disposed in an earlier call to . For more information about how to implement , see Implementing a Dispose Method. - For more information about and , see Cleaning Up Unmanaged Resources. - - Cryptographic Services - - - - - - - - - - Method - - System.Security.Cryptography.Algorithms - 4.3.1.0 - 4.3.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Void - - - - - - The span to fill with cryptographically strong random bytes. - Fills a span with cryptographically strong random bytes. - To be added. - - - - - System.Security.Cryptography.Algorithms - 4.0.0.0 - 4.1.0.0 - 4.2.0.0 - 4.3.0.0 - - - Fills an array of bytes with a cryptographically strong random sequence of values. - - - - - - - - - - Method - - System.Security.Cryptography.Algorithms - 4.0.0.0 - 4.1.0.0 - 4.2.0.0 - 4.3.0.0 - 4.3.1.0 - 4.3.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Void - - - - - - The array to fill with cryptographically strong random bytes. - When overridden in a derived class, fills an array of bytes with a cryptographically strong random sequence of values. - + For more information about and , see Cleaning Up Unmanaged Resources. + + Cryptographic Services + + + + + + + + + + Method + + System.Security.Cryptography.Algorithms + 4.3.1.0 + 4.3.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Void + + + + + + The span to fill with cryptographically strong random bytes. + Fills a span with cryptographically strong random bytes. + To be added. + + + + + System.Security.Cryptography.Algorithms + 4.0.0.0 + 4.1.0.0 + 4.2.0.0 + 4.3.0.0 + + + Fills an array of bytes with a cryptographically strong random sequence of values. + + + + + + + + + + Method + + System.Security.Cryptography.Algorithms + 4.0.0.0 + 4.1.0.0 + 4.2.0.0 + 4.3.0.0 + 4.3.1.0 + 4.3.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Void + + + + + + The array to fill with cryptographically strong random bytes. + When overridden in a derived class, fills an array of bytes with a cryptographically strong random sequence of values. + - - Cryptographic Services - - - - - - - - - - - Method - - System.Security.Cryptography.Algorithms - 6.0.0.0 - - - mscorlib - - - netstandard - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Byte[] - - - - - - The number of bytes of random values to create. - Creates an array of bytes with a cryptographically strong random sequence of values. - An array populated with cryptographically strong random values. - To be added. - - is less than zero. - - - - - - - - - - Method - - System.Security.Cryptography.Algorithms - 4.3.1.0 - 4.3.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Void - - - - - - The span to fill with cryptographically strong random bytes. - Fills a span with cryptographically strong random bytes. - To be added. - - - - - - - - - - - Method - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography.Algorithms - 4.3.0.0 - 4.3.1.0 - 4.3.2.0 - 5.0.0.0 - 6.0.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Void - - - - - - - - The array to fill with cryptographically strong random bytes. - The index of the array to start the fill operation. - The number of bytes to fill. - Fills the specified byte array with a cryptographically strong random sequence of values. - To be added. - - is . - - or is less than 0 - - plus exceeds the length of . - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - 9.0.0.0 - - - System.Security.Cryptography.Algorithms - - - netstandard - - - mscorlib - - - System.String - - - - - - - The length of string to create. - + ]]> + + Cryptographic Services + + + + + + + + + + + Method + + System.Security.Cryptography.Algorithms + 6.0.0.0 + + + mscorlib + + + netstandard + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Byte[] + + + + + + The number of bytes of random values to create. + Creates an array of bytes with a cryptographically strong random sequence of values. + An array populated with cryptographically strong random values. + To be added. + + is less than zero. + + + + + + + + + + Method + + System.Security.Cryptography.Algorithms + 4.3.1.0 + 4.3.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Void + + + + + + The span to fill with cryptographically strong random bytes. + Fills a span with cryptographically strong random bytes. + To be added. + + + + + + + + + + + Method + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography.Algorithms + 4.3.0.0 + 4.3.1.0 + 4.3.2.0 + 5.0.0.0 + 6.0.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Void + + + + + + + + The array to fill with cryptographically strong random bytes. + The index of the array to start the fill operation. + The number of bytes to fill. + Fills the specified byte array with a cryptographically strong random sequence of values. + To be added. + + is . + + or is less than 0 + + plus exceeds the length of . + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + 9.0.0.0 + + + System.Security.Cryptography.Algorithms + + + netstandard + + + mscorlib + + + System.String + + + + + + + The length of string to create. + if the hexadecimal characters should be lowercase; if they should be uppercase. - The default is . - Creates a string filled with cryptographically random hexadecimal characters. - A string populated with random hexadecimal characters. - The behavior of this is the same as using and specifying hexadecimal characters as the choices. This implementation is optimized specifically for hexadecimal characters. - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - 9.0.0.0 - - - System.Security.Cryptography.Algorithms - - - netstandard - - - mscorlib - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Void - - - - - - - The buffer to receive the characters. - + The default is . + Creates a string filled with cryptographically random hexadecimal characters. + A string populated with random hexadecimal characters. + The behavior of this is the same as using and specifying hexadecimal characters as the choices. This implementation is optimized specifically for hexadecimal characters. + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + 9.0.0.0 + + + System.Security.Cryptography.Algorithms + + + netstandard + + + mscorlib + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Void + + + + + + + The buffer to receive the characters. + if the hexadecimal characters should be lowercase; if they should be uppercase. - The default is . - Fills a buffer with cryptographically random hexadecimal characters. - The behavior of this is the same as using and specifying hexadecimal characters as the choices. This implementation is optimized specifically for hexadecimal characters. - - - - - - - - - - Method - - System.Security.Cryptography.Algorithms - 4.3.1.0 - 4.3.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Int32 - - - - - - The exclusive upper bound of the random range. - Generates a random integer between 0 (inclusive) and a specified exclusive upper bound using a cryptographically strong random number generator. - A random integer between 0 (inclusive) and (exclusive). - + The default is . + Fills a buffer with cryptographically random hexadecimal characters. + The behavior of this is the same as using and specifying hexadecimal characters as the choices. This implementation is optimized specifically for hexadecimal characters. + + + + + + + + + + Method + + System.Security.Cryptography.Algorithms + 4.3.1.0 + 4.3.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Int32 + + + + + + The exclusive upper bound of the random range. + Generates a random integer between 0 (inclusive) and a specified exclusive upper bound using a cryptographically strong random number generator. + A random integer between 0 (inclusive) and (exclusive). + - - The parameter is less than or equal to 0. - - - - - - - - - - Method - - System.Security.Cryptography.Algorithms - 4.3.1.0 - 4.3.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Int32 - - - - - - - The inclusive lower bound of the random range. - The exclusive upper bound of the random range. - Generates a random integer between a specified inclusive lower bound and a specified exclusive upper bound using a cryptographically strong random number generator. - A random integer between (inclusive) and (exclusive). - + ]]> + + The parameter is less than or equal to 0. + + + + + + + + + + Method + + System.Security.Cryptography.Algorithms + 4.3.1.0 + 4.3.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Int32 + + + + + + + The inclusive lower bound of the random range. + The exclusive upper bound of the random range. + Generates a random integer between a specified inclusive lower bound and a specified exclusive upper bound using a cryptographically strong random number generator. + A random integer between (inclusive) and (exclusive). + - - The parameter is less than or equal to the parameter. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - 9.0.0.0 - - - System.Security.Cryptography.Algorithms - - - netstandard - - - mscorlib - - - T[] - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] - - - - - - - The type of items. - The items to use to populate the array. - The length of array to return populated with items. - Creates an array populated with items chosen at random from choices. - An array populated with random choices. - To be added. - - is empty. - - is not zero or a positive number. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - 9.0.0.0 - - - System.Security.Cryptography.Algorithms - - - netstandard - - - mscorlib - - - - [System.Runtime.CompilerServices.NullableContext(2)] - [<System.Runtime.CompilerServices.NullableContext(2)>] - - - - System.Void - - - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] - - - - - - The type of items. - The items to use to fill the buffer. - The buffer to receive the items. - Fills the elements of a specified span with items chosen at random from the provided set of choices. - To be added. - - is empty. - - - - - - - - - - - - - - Method - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography.Algorithms - 4.3.0.0 - 4.3.1.0 - 4.3.2.0 - 5.0.0.0 - 6.0.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - System.Void - - - - - - The array to fill with cryptographically strong random nonzero bytes. - When overridden in a derived class, fills an array of bytes with a cryptographically strong random sequence of nonzero values. - + ]]> + + The parameter is less than or equal to the parameter. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + 9.0.0.0 + + + System.Security.Cryptography.Algorithms + + + netstandard + + + mscorlib + + + T[] + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + The type of items. + The items to use to populate the array. + The length of array to return populated with items. + Creates an array populated with items chosen at random from choices. + An array populated with random choices. + To be added. + + is empty. + + is not zero or a positive number. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + 9.0.0.0 + + + System.Security.Cryptography.Algorithms + + + netstandard + + + mscorlib + + + + [System.Runtime.CompilerServices.NullableContext(2)] + [<System.Runtime.CompilerServices.NullableContext(2)>] + + + + System.Void + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + The type of items. + The items to use to fill the buffer. + The buffer to receive the items. + Fills the elements of a specified span with items chosen at random from the provided set of choices. + To be added. + + is empty. + + + + + + + + + + + + + + Method + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography.Algorithms + 4.3.0.0 + 4.3.1.0 + 4.3.2.0 + 5.0.0.0 + 6.0.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + System.Void + + + + + + The array to fill with cryptographically strong random nonzero bytes. + When overridden in a derived class, fills an array of bytes with a cryptographically strong random sequence of nonzero values. + - - Cryptographic Services - - - - - - - - - - Method - - System.Security.Cryptography.Algorithms - 4.3.1.0 - 4.3.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Void - - - - - - The span to fill with cryptographically strong random nonzero bytes. - Fills a byte span with a cryptographically strong random sequence of nonzero values. - To be added. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - 9.0.0.0 - - - System.Security.Cryptography.Algorithms - - - netstandard - - - mscorlib - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.String - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - - The characters to use to populate the string. - The length of string to return. - Creates a string populated with characters chosen at random from choices. - A string populated with random choices. - To be added. - - is empty. - - is not zero or a positive number. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - 9.0.0.0 - - - System.Security.Cryptography.Algorithms - - - netstandard - - - mscorlib - - - - [System.Runtime.CompilerServices.NullableContext(2)] - [<System.Runtime.CompilerServices.NullableContext(2)>] - - - - System.Void - - - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] - - - - - - The type of span. - The span to shuffle. - Performs an in-place shuffle of a span using cryptographically random number generation. - To be added. - - - - + ]]> + + Cryptographic Services + + + + + + + + + + Method + + System.Security.Cryptography.Algorithms + 4.3.1.0 + 4.3.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Void + + + + + + The span to fill with cryptographically strong random nonzero bytes. + Fills a byte span with a cryptographically strong random sequence of nonzero values. + To be added. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + 9.0.0.0 + + + System.Security.Cryptography.Algorithms + + + netstandard + + + mscorlib + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.String + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + + The characters to use to populate the string. + The length of string to return. + Creates a string populated with characters chosen at random from choices. + A string populated with random choices. + To be added. + + is empty. + + is not zero or a positive number. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + 9.0.0.0 + + + System.Security.Cryptography.Algorithms + + + netstandard + + + mscorlib + + + + [System.Runtime.CompilerServices.NullableContext(2)] + [<System.Runtime.CompilerServices.NullableContext(2)>] + + + + System.Void + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + The type of span. + The span to shuffle. + Performs an in-place shuffle of a span using cryptographically random number generation. + To be added. + + + + diff --git a/xml/System.ServiceModel.Description/ServiceDescription.xml b/xml/System.ServiceModel.Description/ServiceDescription.xml index 49d82b148e7..67239c2cac5 100644 --- a/xml/System.ServiceModel.Description/ServiceDescription.xml +++ b/xml/System.ServiceModel.Description/ServiceDescription.xml @@ -466,4 +466,4 @@ - \ No newline at end of file + diff --git a/xml/System.ServiceModel/NetNamedPipeBinding.xml b/xml/System.ServiceModel/NetNamedPipeBinding.xml index d93392013ab..f7911862e72 100644 --- a/xml/System.ServiceModel/NetNamedPipeBinding.xml +++ b/xml/System.ServiceModel/NetNamedPipeBinding.xml @@ -890,4 +890,4 @@ - \ No newline at end of file + From 5a0476f2c98e02b150e2d7b057c9c7898209e5f0 Mon Sep 17 00:00:00 2001 From: huangmin-ms Date: Wed, 28 Aug 2024 10:28:28 +0800 Subject: [PATCH 02/11] Remove assemblyInfo --- xml/System.Collections.Generic/CollectionExtensions.xml | 9 --------- 1 file changed, 9 deletions(-) diff --git a/xml/System.Collections.Generic/CollectionExtensions.xml b/xml/System.Collections.Generic/CollectionExtensions.xml index eb859075971..1967208341c 100644 --- a/xml/System.Collections.Generic/CollectionExtensions.xml +++ b/xml/System.Collections.Generic/CollectionExtensions.xml @@ -20,15 +20,6 @@ netstandard 2.1.0.0 - - Microsoft.Extensions.DependencyModel - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 8.0.0.1 - 9.0.0.0 - From dc702159c3ca133870c010b02c1c236f1b5aa8aa Mon Sep 17 00:00:00 2001 From: "apexvss@microsoft.com" Date: Wed, 28 Aug 2024 06:22:24 +0000 Subject: [PATCH 03/11] CI Update Build.Reason:Manual by Min Huang Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=451135&view=results source_repo.branch:mh/workaround source_repo.url:https://apidrop.visualstudio.com/_git/binaries --- .../CollectionExtensions.xml | 8 +- xml/System.Reflection/TypeExtensions.xml | 441 +++++++++--------- 2 files changed, 219 insertions(+), 230 deletions(-) diff --git a/xml/System.Collections.Generic/CollectionExtensions.xml b/xml/System.Collections.Generic/CollectionExtensions.xml index 1967208341c..2af196c03b6 100644 --- a/xml/System.Collections.Generic/CollectionExtensions.xml +++ b/xml/System.Collections.Generic/CollectionExtensions.xml @@ -277,7 +277,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -332,7 +332,7 @@ - + To be added. @@ -704,7 +704,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -762,7 +762,7 @@ - + diff --git a/xml/System.Reflection/TypeExtensions.xml b/xml/System.Reflection/TypeExtensions.xml index 62b2a33b928..d327019eaf7 100644 --- a/xml/System.Reflection/TypeExtensions.xml +++ b/xml/System.Reflection/TypeExtensions.xml @@ -266,37 +266,23 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Reflection.EventInfo[] + System.Reflection.EventInfo[] - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents)>] - - - - + + To be added. @@ -307,38 +293,23 @@ - - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Reflection.FieldInfo + System.Reflection.FieldInfo - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)>] - - - - + + To be added. @@ -378,36 +349,22 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Reflection.FieldInfo[] + System.Reflection.FieldInfo[] - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)>] - - - + To be added. @@ -570,24 +527,38 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 - System.Reflection.MemberInfo[] + System.Reflection.MemberInfo[] - - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All)>] + + + + + To be added. @@ -692,39 +663,24 @@ - - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Reflection.MethodInfo + System.Reflection.MethodInfo - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)>] - - - - - + + + To be added. @@ -736,13 +692,41 @@ - - - - - - - + + + + + + + Method + + System.Reflection.TypeExtensions + 4.1.5.0 + + + System.Reflection.MethodInfo + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + Method System.Reflection.TypeExtensions @@ -756,7 +740,7 @@ 9.0.0.0 - System.Reflection.MethodInfo + System.Reflection.MethodInfo[] @@ -767,25 +751,21 @@ - - To be added. - To be added. - To be added. To be added. To be added. To be added. - - - - - - + + + + + + Method System.Reflection.TypeExtensions @@ -796,77 +776,94 @@ + To be added. + To be added. To be added. To be added. To be added. - - - - - - - + + + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 - System.Reflection.MethodInfo[] + System.Type - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes)>] + + + + + To be added. + To be added. To be added. To be added. To be added. To be added. - - - - - - - + + + + + + + Method System.Reflection.TypeExtensions 4.1.5.0 - System.Type + System.Type[] - - + To be added. - To be added. To be added. To be added. To be added. To be added. - - - - - - - + + + + + + + Method System.Reflection.TypeExtensions @@ -880,34 +877,32 @@ 9.0.0.0 - System.Type[] + System.Reflection.PropertyInfo[] - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes)>] + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] - To be added. - To be added. To be added. To be added. To be added. - - - - - - + + + + + + Method System.Reflection.TypeExtensions @@ -927,54 +922,56 @@ - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + To be added. + To be added. To be added. To be added. To be added. - - - - - - - + + + + + + + Method System.Reflection.TypeExtensions 4.1.5.0 - System.Reflection.PropertyInfo[] + System.Reflection.PropertyInfo - + To be added. - To be added. + To be added. To be added. To be added. To be added. - - - - - - - + + + + + + + Method System.Reflection.TypeExtensions @@ -994,40 +991,13 @@ - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Reflection.TypeExtensions - 4.1.5.0 - - - System.Reflection.PropertyInfo - - - - - + To be added. @@ -1143,23 +1113,42 @@ - - - - - - + + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 - System.Boolean + System.Boolean - - + + + + + [System.Diagnostics.CodeAnalysis.NotNullWhen(true)] + [<System.Diagnostics.CodeAnalysis.NotNullWhen(true)>] + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + To be added. From f53f53cf7b8cff4e6dccaf832e27ec750be4b5c1 Mon Sep 17 00:00:00 2001 From: Daniel Asaturov Date: Wed, 28 Aug 2024 21:58:26 +0400 Subject: [PATCH 04/11] Fix an error in the output comment (#10325) --- snippets/csharp/System/Object/GetType/GetTypeEx2.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/snippets/csharp/System/Object/GetType/GetTypeEx2.cs b/snippets/csharp/System/Object/GetType/GetTypeEx2.cs index 2ccfbab24d9..1c3edbca961 100644 --- a/snippets/csharp/System/Object/GetType/GetTypeEx2.cs +++ b/snippets/csharp/System/Object/GetType/GetTypeEx2.cs @@ -26,7 +26,7 @@ public static void Main() // The example displays the following output: // 12 is a 32-bit integer. - // 10653 is a 32-bit integer. + // 10653 is a 64-bit integer. // 12 is an unsigned byte. // -5 is a signed byte. // 16.3 is a double-precision floating point. From a614b2eb43c0f9f739cc9b19b2e1a0203237623d Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Wed, 28 Aug 2024 12:47:48 -0700 Subject: [PATCH 05/11] Fixes per UUF feedback (#10326) --- .../ProcessStartInfo/Verb/source.cs | 6 +- xml/Microsoft.CSharp/CSharpCodeProvider.xml | 134 ++-- .../MemoryCacheOptions.xml | 18 +- .../CodeDomProvider.xml | 600 +++++++++--------- xml/System.Collections/ArrayList.xml | 26 +- xml/System.Diagnostics/Process.xml | 9 +- xml/System.Diagnostics/ProcessStartInfo.xml | 9 +- xml/System.Drawing/Size.xml | 175 ++--- xml/System.IO/File.xml | 2 +- xml/System.IO/Path.xml | 2 +- .../JsonSerializerOptions.xml | 8 +- xml/System.Windows.Forms/ListView.xml | 2 +- .../IXmlSerializable.xml | 130 ++-- 13 files changed, 559 insertions(+), 562 deletions(-) diff --git a/snippets/csharp/System.Diagnostics/ProcessStartInfo/Verb/source.cs b/snippets/csharp/System.Diagnostics/ProcessStartInfo/Verb/source.cs index 4b6b2123da0..251f200293e 100644 --- a/snippets/csharp/System.Diagnostics/ProcessStartInfo/Verb/source.cs +++ b/snippets/csharp/System.Diagnostics/ProcessStartInfo/Verb/source.cs @@ -1,5 +1,4 @@ // -// using System; using System.ComponentModel; using System.IO; @@ -49,14 +48,13 @@ static void Main() startInfo.Verb = verbToUse; if (verbToUse.ToLower().IndexOf("printto") >= 0) { - // printto implies a specific printer. Ask for the network address. + // printto implies a specific printer. Ask for the network address. // The address must be in the form \\server\printer. // The printer address is passed as the Arguments property. Console.Write("Enter the network address of the target printer: "); var arguments = Console.ReadLine(); startInfo.Arguments = arguments; } - // try { @@ -81,6 +79,7 @@ static void Main() Console.WriteLine($"Unable to start '{fileName}' with verb {verbToUse}"); } } + // } else { @@ -90,5 +89,4 @@ static void Main() } } } -// // diff --git a/xml/Microsoft.CSharp/CSharpCodeProvider.xml b/xml/Microsoft.CSharp/CSharpCodeProvider.xml index 1eb58ea98ee..15cc64b5be6 100644 --- a/xml/Microsoft.CSharp/CSharpCodeProvider.xml +++ b/xml/Microsoft.CSharp/CSharpCodeProvider.xml @@ -32,22 +32,24 @@ Provides access to instances of the C# code generator and code compiler. - and implementations. - + and implementations. + > [!NOTE] -> This class contains a link demand and an inheritance demand at the class level that applies to all members. A is thrown when either the immediate caller or the derived class does not have full-trust permission. - - - -## Examples - The following example uses either the C# or Visual Basic code provider to compile a source file. The example checks the input file extension and uses the corresponding or for compilation. The input file is compiled into an executable file, and any compilation errors are displayed to the console. - +> This class contains a link demand and an inheritance demand at the class level that applies to all members. A is thrown when either the immediate caller or the derived class does not have full-trust permission. + +## Examples + The following example uses either the C# or Visual Basic code provider to compile a source file. The example checks the input file extension and uses the corresponding or for compilation. The input file is compiled into an executable file, and any compilation errors are displayed to the console. + +> [!IMPORTANT] +> The `CompileAssemblyFrom*` methods aren't supported on .NET Core and .NET 5+. This example only runs on .NET Framework. + :::code language="csharp" source="~/snippets/csharp/Microsoft.CSharp/CSharpCodeProvider/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_CodeProviders/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_CodeProviders/VB/source.vb" id="Snippet1"::: + ]]> @@ -124,40 +126,40 @@ A object that contains the provider options. Initializes a new instance of the class by using the specified provider options. - ](/dotnet/framework/configure-apps/file-schema/compiler/provideroption-element) element in the configuration file. You can identify the version of the you want to use by specifying the `` element, supplying "CompilerVersion" as the option name, and supplying the version number (for example, "v3.5") as the option value. You must precede the version number with a lower case "v". The following configuration file example demonstrates how to specify that version 3.5 of the C# code provider should be used. - -```xml - - - - - - - - - - -``` +In .NET Framework apps, you can obtain the value for `providerOptions` from the [\](/dotnet/framework/configure-apps/file-schema/compiler/provideroption-element) element in the configuration file. You can identify the version of the you want to use by specifying the `` element, supplying "CompilerVersion" as the option name, and supplying the version number (for example, "v3.5") as the option value. You must precede the version number with a lower case "v". The following configuration file example demonstrates how to specify that version 3.5 of the C# code provider should be used. + +```xml + + + + + + + + + + +``` ## Examples - The following example shows how to specify the compiler version when you create a new instance of the class. - - :::code language="csharp" source="~/snippets/csharp/Microsoft.CSharp/CSharpCodeProvider/.ctor/program.cs" id="Snippet1"::: - + The following example shows how to specify the compiler version when you create a new instance of the class. + + :::code language="csharp" source="~/snippets/csharp/Microsoft.CSharp/CSharpCodeProvider/.ctor/program.cs" id="Snippet1"::: + ]]> @@ -291,11 +293,11 @@ In .NET Framework apps, you can obtain the value for `providerOptions` from the Gets the file name extension to use when creating source code files. The file name extension to use for generated source code files. - @@ -337,19 +339,19 @@ In .NET Framework apps, you can obtain the value for `providerOptions` from the The to use when generating the code. Generates code for the specified class member using the specified text writer and code generator options. - method to create a code fragment to be used in a CodeDOM graph. This code example is part of a larger example provided for the method of the class. - + method to create a code fragment to be used in a CodeDOM graph. This code example is part of a larger example provided for the method of the class. + :::code language="csharp" source="~/snippets/csharp/Microsoft.CSharp/CSharpCodeProvider/GenerateCodeFromMember/program.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_GenerateCodeFromMember/vb/module1.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_GenerateCodeFromMember/vb/module1.vb" id="Snippet3"::: + ]]> @@ -392,11 +394,11 @@ In .NET Framework apps, you can obtain the value for `providerOptions` from the Gets a for the specified type of object. A for the specified type. - diff --git a/xml/Microsoft.Extensions.Caching.Memory/MemoryCacheOptions.xml b/xml/Microsoft.Extensions.Caching.Memory/MemoryCacheOptions.xml index 49f21066301..e99fc147659 100644 --- a/xml/Microsoft.Extensions.Caching.Memory/MemoryCacheOptions.xml +++ b/xml/Microsoft.Extensions.Caching.Memory/MemoryCacheOptions.xml @@ -210,9 +210,9 @@ Gets or sets the maximum size of the cache. To be added. - [!CAUTION] -> There may be transient states while the cache is full but blocks are being released on a background thread. In this state, unexpected behavior might occur if the cache is being overutilized. + [!CAUTION] +> There might be transient states while the cache is full but blocks are being released on a background thread. In this state, unexpected behavior might occur if the cache is being overutilized. ]]> @@ -238,12 +238,12 @@ if linked entries are tracked; otherwise, . The default is in .NET 7 and later versions. - diff --git a/xml/System.CodeDom.Compiler/CodeDomProvider.xml b/xml/System.CodeDom.Compiler/CodeDomProvider.xml index aad6663a6d1..f3fc7f66d2a 100644 --- a/xml/System.CodeDom.Compiler/CodeDomProvider.xml +++ b/xml/System.CodeDom.Compiler/CodeDomProvider.xml @@ -43,34 +43,34 @@ Provides a base class for implementations. This class is abstract. - can be used to create and retrieve instances of code generators and code compilers. Code generators can be used to generate code in a particular language, and code compilers can be used to compile code into assemblies. - + can be used to create and retrieve instances of code generators and code compilers. Code generators can be used to generate code in a particular language, and code compilers can be used to compile code into assemblies. + > [!NOTE] -> In the .NET Framework 2.0, the methods made available in the code generator and code compiler are available directly from the code provider. You do not need to call or to access the methods, and those methods are marked as obsolete. This applies to preexisting as well as new code provider implementations. - - A implementation typically provides code generation and/or code compilation interfaces for generating code and managing compilation for a single programming language. Several languages are supported by implementations that ship with the Windows SDK. These languages include C#, Visual Basic, C++, and JScript. Developers or compiler vendors can implement the and interfaces and provide a that extends CodeDOM support to other programming languages. - - The [<system.codedom> Element](/dotnet/framework/configure-apps/file-schema/compiler/system-codedom-element) in the machine configuration file (Machine.config) provides a mechanism for developers and compiler vendors to add configuration settings for additional implementations. - - The class provides static methods to discover and enumerate the implementations on a computer. The method returns the settings for all implementations on a computer. The method returns the settings for a specific implementation, based on the programming language name. The method returns an instance of a implementation for a specific language. - - For more details on language provider settings in the configuration file, see [Compiler and Language Provider Settings Schema](/dotnet/framework/configure-apps/file-schema/compiler/). - +> In the .NET Framework 2.0, the methods made available in the code generator and code compiler are available directly from the code provider. You do not need to call or to access the methods, and those methods are marked as obsolete. This applies to preexisting as well as new code provider implementations. + + A implementation typically provides code generation and/or code compilation interfaces for generating code and managing compilation for a single programming language. Several languages are supported by implementations that ship with the Windows SDK. These languages include C#, Visual Basic, C++, and JScript. Developers or compiler vendors can implement the and interfaces and provide a that extends CodeDOM support to other programming languages. + + The [<system.codedom> Element](/dotnet/framework/configure-apps/file-schema/compiler/system-codedom-element) in the machine configuration file (Machine.config) provides a mechanism for developers and compiler vendors to add configuration settings for additional implementations. + + The class provides static methods to discover and enumerate the implementations on a computer. The method returns the settings for all implementations on a computer. The method returns the settings for a specific implementation, based on the programming language name. The method returns an instance of a implementation for a specific language. + + For more details on language provider settings in the configuration file, see [Compiler and Language Provider Settings Schema](/dotnet/framework/configure-apps/file-schema/compiler/). + > [!NOTE] -> This class makes a link demand and an inheritance demand at the class level. A is thrown if either the immediate caller or the derived class does not have full trust permission. For details about security demands, see [Link Demands](/dotnet/framework/misc/link-demands) and [Inheritance Demands](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/x4yx82e6(v=vs.100)). - - - -## Examples - The following example program can generate and compile source code based on a CodeDOM model of a program that prints "Hello World" using the class. A Windows Forms user interface is provided. The user can select the target programming language from several selections: C#, Visual Basic, and JScript. - +> This class makes a link demand and an inheritance demand at the class level. A is thrown if either the immediate caller or the derived class does not have full trust permission. For details about security demands, see [Link Demands](/dotnet/framework/misc/link-demands) and [Inheritance Demands](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/x4yx82e6(v=vs.100)). + + + +## Examples + The following example program can generate and compile source code based on a CodeDOM model of a program that prints "Hello World" using the class. A Windows Forms user interface is provided. The user can select the target programming language from several selections: C#, Visual Basic, and JScript. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CodeDomExample/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom/CodeCompileUnit/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDomExample/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDomExample/VB/source.vb" id="Snippet1"::: + ]]> @@ -161,16 +161,16 @@ Compiles an assembly based on the trees contained in the specified array of objects, using the specified compiler settings. A object that indicates the results of the compilation. - [!NOTE] -> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. + [!NOTE] +## Remarks + +> [!IMPORTANT] > On .NET Core and .NET 5+, calls to the `CodeDomProvider.CompileAssemblyFromDom` method throw a . Compile code is not supported. - + +> [!NOTE] +> In .NET Framework 2.0 and later versions, this method can be called directly on the code provider even if it's not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. + ]]> Neither this method nor the method is overridden in a derived class. @@ -226,16 +226,16 @@ Compiles an assembly from the source code contained in the specified files, using the specified compiler settings. A object that indicates the results of compilation. - [!NOTE] -> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. + [!NOTE] +## Remarks + +> [!IMPORTANT] > On .NET Core and .NET 5+, calls to the `CodeDomProvider.CompileAssemblyFromFile` method throw a . Compile from file is not supported. +> [!NOTE] +> In .NET Framework 2.0 and later versions, this method can be called directly on the code provider even if it's not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. + ]]> Neither this method nor the method is overridden in a derived class. @@ -290,16 +290,16 @@ Compiles an assembly from the specified array of strings containing source code, using the specified compiler settings. A object that indicates the results of compilation. - [!NOTE] -> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. + [!NOTE] +## Remarks + +> [!IMPORTANT] > On .NET Core and .NET 5+, calls to the `CodeDomProvider.CompileAssemblyFromSource` method throw a . Compile source code is not supported. +> [!NOTE] +> In .NET Framework 2.0 and later versions, this method can be called directly on the code provider even if it's not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. + ]]> Neither this method nor the method is overridden in a derived class. @@ -353,11 +353,11 @@ When overridden in a derived class, creates a new code compiler. An that can be used for compilation of based source code representations. - methods that are directly available in the code provider. - + methods that are directly available in the code provider. + ]]> @@ -399,14 +399,14 @@ Creates an escaped identifier for the specified value. The escaped identifier for the value. - tests whether the identifier conflicts with any reserved or language keywords, and if so, returns an equivalent name with language-specific escape code formatting. This is referred to an escaped identifier. The escaped identifier contains the same `value` but has escape-code formatting added to differentiate the identifier from the keyword. Two implementation examples are preceding the `value` with "@" or bracketing the `value` with "[" and "]". - + tests whether the identifier conflicts with any reserved or language keywords, and if so, returns an equivalent name with language-specific escape code formatting. This is referred to an escaped identifier. The escaped identifier contains the same `value` but has escape-code formatting added to differentiate the identifier from the keyword. Two implementation examples are preceding the `value` with "@" or bracketing the `value` with "[" and "]". + > [!NOTE] -> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. - +> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. + ]]> Neither this method nor the method is overridden in a derived class. @@ -466,11 +466,11 @@ When overridden in a derived class, creates a new code generator. An that can be used to generate based source code representations. - methods that are directly available in the class. - + methods that are directly available in the class. + ]]> @@ -519,14 +519,14 @@ When overridden in a derived class, creates a new code generator using the specified for output. An that can be used to generate based source code representations. - for output. This method supports more optimized code generation that incrementally updates the source code. - + for output. This method supports more optimized code generation that incrementally updates the source code. + > [!NOTE] -> The base class implementation calls the method, which is obsolete in the .NET Framework 2.0 and results in a if an object is not returned. - +> The base class implementation calls the method, which is obsolete in the .NET Framework 2.0 and results in a if an object is not returned. + ]]> @@ -573,14 +573,14 @@ When overridden in a derived class, creates a new code generator using the specified file name for output. An that can be used to generate based source code representations. - [!NOTE] -> The base class implementation calls the method, which is obsolete in the .NET Framework 2.0 and results in a if an object is not returned. - +> The base class implementation calls the method, which is obsolete in the .NET Framework 2.0 and results in a if an object is not returned. + ]]> @@ -678,36 +678,36 @@ Gets a instance for the specified language. A CodeDOM provider that is implemented for the specified language name. - [!NOTE] -> This method is most commonly used to create an instance of a code provider in an application that may optionally use one of several providers. allows you to specify at run time the code provider you wish to instantiate. If you know at design time which code provider is to be used, you should create an instance of that code provider rather than use the method. - - The method returns a instance for a specific language name; it is similar to calling the method with the language provider type. Use when you want to dynamically find a configured provider implementation for a language name. - - If more than one provider implementation is configured for the language name, returns a provider instance for the last matching configuration element. - - Use the method overload when you want a specific language provider implementation. For example, use the method to get a provider instance that supports the language name `"CSharp"`; use the method overload to get a provider instance specifically for the implementation. Use the method if you have multiple code providers for a language and you desire to instantiate a specific code provider. - - The method checks whether at least one provider implementation supports a specific language. You can validate a language name using before passing it to . If you pass an unsupported language name to a is thrown. - - The method can be used to determine all implementations on a computer, including additional implementations provided by developers and compiler vendors that are identified in the [<system.codedom> Element](/dotnet/framework/configure-apps/file-schema/compiler/system-codedom-element) in the machine configuration file (Machine.config). - - The method returns an instance of a implementation for a specific language. - - Language names are case-insensitive. - - - -## Examples - The following code example determines the implementation for an input language and displays the configured settings for the language provider. This code example is part of a larger example provided for the class. - +> This method is most commonly used to create an instance of a code provider in an application that may optionally use one of several providers. allows you to specify at run time the code provider you wish to instantiate. If you know at design time which code provider is to be used, you should create an instance of that code provider rather than use the method. + + The method returns a instance for a specific language name; it is similar to calling the method with the language provider type. Use when you want to dynamically find a configured provider implementation for a language name. + + If more than one provider implementation is configured for the language name, returns a provider instance for the last matching configuration element. + + Use the method overload when you want a specific language provider implementation. For example, use the method to get a provider instance that supports the language name `"CSharp"`; use the method overload to get a provider instance specifically for the implementation. Use the method if you have multiple code providers for a language and you desire to instantiate a specific code provider. + + The method checks whether at least one provider implementation supports a specific language. You can validate a language name using before passing it to . If you pass an unsupported language name to a is thrown. + + The method can be used to determine all implementations on a computer, including additional implementations provided by developers and compiler vendors that are identified in the [<system.codedom> Element](/dotnet/framework/configure-apps/file-schema/compiler/system-codedom-element) in the machine configuration file (Machine.config). + + The method returns an instance of a implementation for a specific language. + + Language names are case-insensitive. + + + +## Examples + The following code example determines the implementation for an input language and displays the configured settings for the language provider. This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CodeDom_CompilerInfo/CPP/source.cpp" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/CodeDomProvider/CreateProvider/source.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_CompilerInfo/VB/source.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_CompilerInfo/VB/source.vb" id="Snippet6"::: + ]]> The does not have a configured provider on this computer. @@ -757,25 +757,25 @@ Gets a instance for the specified language and provider options. A CodeDOM provider that is implemented for the specified language name and options. - [!NOTE] -> This method is most commonly used to create an instance of a code provider in an application that may optionally use one of several providers. enables you to specify at run time the version of the code provider you want to instantiate. If you know at design time which code provider is to be used, you should create an instance of that code provider instead of using the method. - - Use when you want to dynamically find a configured provider implementation for a specific language and options. Language names are case-insensitive. For information about supported provider options, see the specific CodeDOM provider documentation. - - For information about validating a provider and calling a provider if more than one provider implementation is configured for the language name, see the Remarks section of the method. - - - -## Examples - The following example shows how to create an instance of a provider by using the `providerOptions` parameter. - +> This method is most commonly used to create an instance of a code provider in an application that may optionally use one of several providers. enables you to specify at run time the version of the code provider you want to instantiate. If you know at design time which code provider is to be used, you should create an instance of that code provider instead of using the method. + + Use when you want to dynamically find a configured provider implementation for a specific language and options. Language names are case-insensitive. For information about supported provider options, see the specific CodeDOM provider documentation. + + For information about validating a provider and calling a provider if more than one provider implementation is configured for the language name, see the Remarks section of the method. + + + +## Examples + The following example shows how to create an instance of a provider by using the `providerOptions` parameter. + :::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/CodeDomProvider/CreateProvider/program.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/codedomprovider.provideroptions/vb/program.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/codedomprovider.provideroptions/vb/program.vb" id="Snippet1"::: + ]]> @@ -814,14 +814,14 @@ Creates a valid identifier for the specified value. A valid identifier for the specified value. - tests whether the identifier conflicts with reserved or language keywords, and if so, attempts to return a valid identifier name that does not conflict. Usually the returned identifier is only slightly modified to differentiate the identifier from the keyword; for example, the name might be preceded by the underscore ("_") character. - + tests whether the identifier conflicts with reserved or language keywords, and if so, attempts to return a valid identifier name that does not conflict. Usually the returned identifier is only slightly modified to differentiate the identifier from the keyword; for example, the name might be preceded by the underscore ("_") character. + > [!NOTE] -> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. - +> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. + ]]> Neither this method nor the method is overridden in a derived class. @@ -867,20 +867,20 @@ Gets the default file name extension to use for source code files in the current language. A file name extension corresponding to the extension of the source files of the current language. The base implementation always returns . - . The example displays the provider name, hash code and default file name extension for the new provider instance. - + . The example displays the provider name, hash code and default file name extension for the new provider instance. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CodeDom_CompilerInfo/CPP/source.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/CodeDomProvider/CreateProvider/source.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_CompilerInfo/VB/source.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_CompilerInfo/VB/source.vb" id="Snippet3"::: + ]]> @@ -922,22 +922,22 @@ A that indicates the options to use for generating code. Generates code for the specified Code Document Object Model (CodeDOM) compilation unit and sends it to the specified text writer, using the specified options. - [!NOTE] -> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. - - - -## Examples - The following code example shows the use of the method to generate code for a "Hello World" application from a . This example is part of a larger example provided for the class. - +> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. + + + +## Examples + The following code example shows the use of the method to generate code for a "Hello World" application from a . This example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CodeDomExample/CPP/source.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom/CodeCompileUnit/Overview/source.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDomExample/VB/source.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDomExample/VB/source.vb" id="Snippet3"::: + ]]> Neither this method nor the method is overridden in a derived class. @@ -986,13 +986,13 @@ A that indicates the options to use for generating code. Generates code for the specified Code Document Object Model (CodeDOM) expression and sends it to the specified text writer, using the specified options. - [!NOTE] -> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. - +> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. + ]]> Neither this method nor the method is overridden in a derived class. @@ -1041,19 +1041,19 @@ A that indicates the options to use for generating code. Generates code for the specified Code Document Object Model (CodeDOM) member declaration and sends it to the specified text writer, using the specified options. - . See for documentation describing an implementation of this method. - - - -## Examples - The following code example shows the use of the method as implemented by the and classes. - + . See for documentation describing an implementation of this method. + + + +## Examples + The following code example shows the use of the method as implemented by the and classes. + :::code language="csharp" source="~/snippets/csharp/Microsoft.CSharp/CSharpCodeProvider/GenerateCodeFromMember/program.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_GenerateCodeFromMember/vb/module1.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_GenerateCodeFromMember/vb/module1.vb" id="Snippet1"::: + ]]> This method is not overridden in a derived class. @@ -1099,13 +1099,13 @@ A that indicates the options to use for generating code. Generates code for the specified Code Document Object Model (CodeDOM) namespace and sends it to the specified text writer, using the specified options. - [!NOTE] -> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. - +> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. + ]]> Neither this method nor the method is overridden in a derived class. @@ -1154,13 +1154,13 @@ A that indicates the options to use for generating code. Generates code for the specified Code Document Object Model (CodeDOM) statement and sends it to the specified text writer, using the specified options. - [!NOTE] -> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. - +> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. + ]]> Neither this method nor the method is overridden in a derived class. @@ -1209,13 +1209,13 @@ A that indicates the options to use for generating code. Generates code for the specified Code Document Object Model (CodeDOM) type declaration and sends it to the specified text writer, using the specified options. - [!NOTE] -> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. - +> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. + ]]> Neither this method nor the method is overridden in a derived class. @@ -1264,23 +1264,23 @@ Returns the language provider and compiler configuration settings for this computer. An array of type representing the settings of all configured implementations. - method to enumerate the language provider settings on a computer. - + method to enumerate the language provider settings on a computer. + > [!NOTE] -> In the .NET Framework 2.0, the default language providers supplied by the .NET Framework are not specified in the [<system.codedom> Element](/dotnet/framework/configure-apps/file-schema/compiler/system-codedom-element) compiler configuration section and cannot be removed, so this method returns information about the default providers and any specified in the configuration file. - - - -## Examples - The following code example enumerates the language providers on the computer and displays the configuration and compiler settings for each language provider. This code example is part of a larger example provided for the class. - +> In the .NET Framework 2.0, the default language providers supplied by the .NET Framework are not specified in the [<system.codedom> Element](/dotnet/framework/configure-apps/file-schema/compiler/system-codedom-element) compiler configuration section and cannot be removed, so this method returns information about the default providers and any specified in the configuration file. + + + +## Examples + The following code example enumerates the language providers on the computer and displays the configuration and compiler settings for each language provider. This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CodeDom_CompilerInfo/CPP/source.cpp" id="Snippet8"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/CodeDomProvider/CreateProvider/source.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_CompilerInfo/VB/source.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_CompilerInfo/VB/source.vb" id="Snippet8"::: + ]]> The caller does not have the required permission. @@ -1328,26 +1328,26 @@ Returns the language provider and compiler configuration settings for the specified language. A object populated with settings of the configured implementation. - implementation on the computer. For information about machine configuration files, see the Machine Configuration Files section in [Configuring Apps](/dotnet/framework/configure-apps/). The method searches each provider configuration element for the specified language name. The returned instance contains the configured language provider and compiler settings. - - The method checks whether at least one provider implementation supports a specific language. You can validate a language name using before passing it to . This prevents throwing a when you access the instance for an unsupported language name. - - If more than one provider implementation is configured for the input language name, returns the settings from the last matching provider configuration element. - - Language names are case-insensitive. - - - -## Examples - The following code example determines the implementation for an input language and displays the configured settings for the language provider. This code example is part of a larger example provided for the class. - + implementation on the computer. For information about machine configuration files, see the Machine Configuration Files section in [Configuring Apps](/dotnet/framework/configure-apps/). The method searches each provider configuration element for the specified language name. The returned instance contains the configured language provider and compiler settings. + + The method checks whether at least one provider implementation supports a specific language. You can validate a language name using before passing it to . This prevents throwing a when you access the instance for an unsupported language name. + + If more than one provider implementation is configured for the input language name, returns the settings from the last matching provider configuration element. + + Language names are case-insensitive. + + + +## Examples + The following code example determines the implementation for an input language and displays the configured settings for the language provider. This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CodeDom_CompilerInfo/CPP/source.cpp" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/CodeDomProvider/CreateProvider/source.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_CompilerInfo/VB/source.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_CompilerInfo/VB/source.vb" id="Snippet6"::: + ]]> The does not have a configured provider on this computer. @@ -1393,11 +1393,11 @@ Gets a for the specified data type. A for the specified type, or if a for the specified type cannot be found. - @@ -1443,26 +1443,26 @@ Returns a language name associated with the specified file name extension, as configured in the compiler configuration section. A language name associated with the file name extension, as configured in the compiler configuration settings. - implementation on the computer. The method searches each provider configuration element for the specified file name extension. - - The method checks whether at least one provider implementation supports a specific file name extension. You can validate a file name extension using before passing it to . This prevents from throwing a for an unsupported file name extension. - - If a provider implementation supports the input file name extension, and there are multiple supported languages configured for that provider, then returns the first language name for that provider. If more than one provider implementation is configured for the input file name extension, returns the language name from the last matching provider configuration element. - - Language names and file name extensions are case-insensitive. - - - -## Examples - The following code example determines the implementation for an input file name extension and displays the configured settings for the language provider. This code example is part of a larger example provided for the class. - + implementation on the computer. The method searches each provider configuration element for the specified file name extension. + + The method checks whether at least one provider implementation supports a specific file name extension. You can validate a file name extension using before passing it to . This prevents from throwing a for an unsupported file name extension. + + If a provider implementation supports the input file name extension, and there are multiple supported languages configured for that provider, then returns the first language name for that provider. If more than one provider implementation is configured for the input file name extension, returns the language name from the last matching provider configuration element. + + Language names and file name extensions are case-insensitive. + + + +## Examples + The following code example determines the implementation for an input file name extension and displays the configured settings for the language provider. This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CodeDom_CompilerInfo/CPP/source.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/CodeDomProvider/CreateProvider/source.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_CompilerInfo/VB/source.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_CompilerInfo/VB/source.vb" id="Snippet5"::: + ]]> The does not have a configured language provider on this computer. @@ -1507,13 +1507,13 @@ Gets the type indicated by the specified . A text representation of the specified type, formatted for the language in which code is generated by this code generator. In Visual Basic, for example, passing in a for the type will return "Integer". - [!NOTE] -> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. - +> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. + ]]> Neither this method nor the method is overridden in a derived class. @@ -1563,22 +1563,22 @@ if a implementation is configured for the specified file name extension; otherwise, . - implementation on the computer. The method searches the provider configuration elements for the specified file name extension. - - File name extensions are case-insensitive. - - - -## Examples - The following code example determines the implementation for an input file name extension and displays the configured settings for the language provider. This code example is part of a larger example provided for the class. - + implementation on the computer. The method searches the provider configuration elements for the specified file name extension. + + File name extensions are case-insensitive. + + + +## Examples + The following code example determines the implementation for an input file name extension and displays the configured settings for the language provider. This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CodeDom_CompilerInfo/CPP/source.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/CodeDomProvider/CreateProvider/source.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_CompilerInfo/VB/source.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_CompilerInfo/VB/source.vb" id="Snippet5"::: + ]]> The is . @@ -1629,22 +1629,22 @@ if a implementation is configured for the specified language; otherwise, . - implementation on the computer. The method searches the provider configuration elements for the specified language name. - - Language names are case-insensitive. - - - -## Examples - The following code example determines the implementation for an input language and displays the configured settings for the language provider. This code example is part of a larger example provided for the class. - + implementation on the computer. The method searches the provider configuration elements for the specified language name. + + Language names are case-insensitive. + + + +## Examples + The following code example determines the implementation for an input language and displays the configured settings for the language provider. This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CodeDom_CompilerInfo/CPP/source.cpp" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/CodeDomProvider/CreateProvider/source.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_CompilerInfo/VB/source.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeDom_CompilerInfo/VB/source.vb" id="Snippet6"::: + ]]> The is . @@ -1688,20 +1688,20 @@ if the parameter is a valid identifier; otherwise, . - method is provider specific. Identifiers that are valid for one provider might not be valid for other providers. If `value` contains characters outside of the ASCII character range, check the identifier for all the languages that might be used to compile the code. - + method is provider specific. Identifiers that are valid for one provider might not be valid for other providers. If `value` contains characters outside of the ASCII character range, check the identifier for all the languages that might be used to compile the code. + > [!NOTE] -> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. - +> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. + ]]> Neither this method nor the method is overridden in a derived class. - When overriding in a derived class, design the method to return only if the value fits the rules of the language and does not conflict with a keyword. - + When overriding in a derived class, design the method to return only if the value fits the rules of the language and does not conflict with a keyword. + If you override this method, you must not call the corresponding method of the base class. The base-class method creates a generator in the derived class using the obsolete method for compatibility with preexisting providers that use code generators. The base-class method then calls the equivalent method in the implementation to perform this function. You will get a if you call the base-class method from a code provider that does not use a code generator. @@ -1773,13 +1773,13 @@ Compiles the code read from the specified text stream into a . A that contains a representation of the parsed code. - [!NOTE] -> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. - +> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. + ]]> Neither this method nor the method is overridden in a derived class. @@ -1825,14 +1825,14 @@ if the specified code generation support is provided; otherwise, . - flags at once to test for a set of capabilities by joining a set of appropriate capability flags together with a binary `OR` operator (|). - + flags at once to test for a set of capabilities by joining a set of appropriate capability flags together with a binary `OR` operator (|). + > [!NOTE] -> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. - +> In the .NET Framework versions 1.0 and 1.1, this method is provided by the implementation that is returned by the method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. + ]]> Neither this method nor the method is overridden in a derived class. diff --git a/xml/System.Collections/ArrayList.xml b/xml/System.Collections/ArrayList.xml index a74f71694e2..f4ba76463e6 100644 --- a/xml/System.Collections/ArrayList.xml +++ b/xml/System.Collections/ArrayList.xml @@ -115,19 +115,19 @@ ## Remarks > [!IMPORTANT] -> We don't recommend that you use the `ArrayList` class for new development. Instead, we recommend that you use the generic class. +> We don't recommend that you use the `ArrayList` class for new development. Instead, we recommend that you use the generic class. > The class is designed to hold heterogeneous collections of objects. However, it does not always offer the best performance. Instead, we recommend the following: > - For a heterogeneous collection of objects, use the `List` (in C#) or `List(Of Object)` (in Visual Basic) type. > - For a homogeneous collection of objects, use the class. -> See [Performance Considerations](xref:System.Collections.Generic.List%601#performance-considerations) in the reference topic for a discussion of the relative performance of these classes. See [Non-generic collections shouldn't be used](https://github.com/dotnet/platform-compat/blob/master/docs/DE0006.md) on GitHub for general information on the use of generic instead of non-generic collection types. +> See [Performance Considerations](xref:System.Collections.Generic.List%601#performance-considerations) in the reference topic for a discussion of the relative performance of these classes. See [Non-generic collections shouldn't be used](https://github.com/dotnet/platform-compat/blob/master/docs/DE0006.md) on GitHub for general information on the use of generic instead of non-generic collection types. - The is not guaranteed to be sorted. You must sort the by calling its method prior to performing operations (such as ) that require the to be sorted. To maintain a collection that is automatically sorted as new elements are added, you can use the class. + The is not guaranteed to be sorted. You must sort the by calling its method prior to performing operations (such as ) that require the to be sorted. To maintain a collection that is automatically sorted as new elements are added, you can use the class. The capacity of an is the number of elements the can hold. As elements are added to an , the capacity is automatically increased as required through reallocation. The capacity can be decreased by calling or by setting the property explicitly. **.NET Framework only:** For very large objects, you can increase the maximum capacity to 2 billion elements on a 64-bit system by setting the `enabled` attribute of the [``](/dotnet/framework/configure-apps/file-schema/runtime/gcallowverylargeobjects-element) configuration element to `true` in the run-time environment. - Elements in this collection can be accessed using an integer index. Indexes in this collection are zero-based. + Elements in this collection can be accessed using an integer index. Indexes in this collection are zero-based. The collection accepts `null` as a valid value. It also allows duplicate elements. @@ -684,8 +684,6 @@ This method is an `O(1)` operation. This method is an `O(log n)` operation, where `n` is . - - ## Examples The following code example shows how to use to locate a specific object in the . @@ -781,8 +779,6 @@ This method is an `O(1)` operation. This method is an `O(log n)` operation, where `n` is . - - ## Examples The following example creates an of colored animals. The provided performs the string comparison for the binary search. The results of both an iterative search and a binary search are displayed. @@ -1023,7 +1019,7 @@ This method is an `O(1)` operation. ## Remarks is set to zero, and references to other objects from elements of the collection are also released. - remains unchanged. To reset the capacity of the , call or set the property directly. Trimming an empty sets the capacity of the to the default capacity. + remains unchanged. To reset the capacity of the , call or set the property directly. Trimming an empty sets the capacity of the to the default capacity. This method is an `O(n)` operation, where `n` is . @@ -1749,11 +1745,11 @@ This method is an `O(1)` operation. also brings the enumerator back to this position. At this position, is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . + Initially, the enumerator is positioned before the first element in the collection. also brings the enumerator back to this position. At this position, is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . returns the same object until either or is called. sets to the next element. @@ -1761,7 +1757,7 @@ This method is an `O(1)` operation. An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined. - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. This method is an `O(1)` operation. @@ -1839,11 +1835,11 @@ This method is an `O(1)` operation. also brings the enumerator back to this position. At this position, is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . + Initially, the enumerator is positioned before the first element in the collection. also brings the enumerator back to this position. At this position, is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . returns the same object until either or is called. sets to the next element. @@ -1851,7 +1847,7 @@ This method is an `O(1)` operation. An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined. - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. This method is an `O(1)` operation. diff --git a/xml/System.Diagnostics/Process.xml b/xml/System.Diagnostics/Process.xml index 7000af75d69..228cdfc9b5a 100644 --- a/xml/System.Diagnostics/Process.xml +++ b/xml/System.Diagnostics/Process.xml @@ -2660,16 +2660,19 @@ The calling process is a member of the associated process's descendant tree. Gets the main module for the associated process. - The that was used to start the process. + The that was used to start the process, or if no main module was found. property lets you view information about the executable used to start the process, including the module name, file name, and module memory details. + +A process module represents a .dll or .exe file that's loaded into a particular process. The property lets you view information about the executable used to start the process, including the module name, file name, and module memory details. + +If no main module is found, it could be because the process hasn't finished loading the main module when the property is called. ]]> - You are trying to access the property for a process that is running on a remote computer. This property is available only for processes that are running on the local computer. + You are trying to access the property for a process that's running on a remote computer. This property is available only for processes that are running on the local computer. A 32-bit process is trying to access the modules of a 64-bit process. The process is not available. diff --git a/xml/System.Diagnostics/ProcessStartInfo.xml b/xml/System.Diagnostics/ProcessStartInfo.xml index 009f1024c14..bb27c0f58e6 100644 --- a/xml/System.Diagnostics/ProcessStartInfo.xml +++ b/xml/System.Diagnostics/ProcessStartInfo.xml @@ -1958,11 +1958,10 @@ You can use asynchronous read operations to avoid these dependencies and their d property. For example, the "`print`" verb will print a document specified by using . The default verb can be specified by using an empty string (""). Examples of verbs are "Edit", "Open", "OpenAsReadOnly", "Print", and "Printto". You should use only verbs that appear in the set of verbs returned by the property. - - When you use the property, you must include the file name extension when you set the value of the property. The file name does not need to have an extension if you manually enter a value for the property. +Each file name extension has its own set of verbs, which can be obtained by using the property. For example, the "`print`" verb prints a document specified by using . The default verb can be specified by using an empty string (""). Examples of verbs are "Edit", "Open", "OpenAsReadOnly", "Print", and "Printto". You should use only verbs that appear in the set of verbs returned by the property. +When you use the property, you must include the file name extension when you set the value of the property. The file name does not need to have an extension if you manually enter a value for the property. ## Examples The following code example starts a new process by using the specified verb and file name. This code example is part of a larger example provided for the property. @@ -2032,12 +2031,10 @@ You can use asynchronous read operations to avoid these dependencies and their d When you use the property, you must include the file name extension when you set the value of the property. The file name extension determines the set of possible verbs. - - ## Examples The following code example displays the defined verbs for the chosen file name. If the user selects one of the defined verbs, the example starts a new process using the selected verb and the input file name. - :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/ProcessStartInfo/Verb/source.cs" id="Snippet3"::: + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/ProcessStartInfo/Verb/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/ProcessVerbs_Diagnostics/VB/source.vb" id="Snippet3"::: ]]> diff --git a/xml/System.Drawing/Size.xml b/xml/System.Drawing/Size.xml index 6f2c2930f01..47474808492 100644 --- a/xml/System.Drawing/Size.xml +++ b/xml/System.Drawing/Size.xml @@ -77,11 +77,12 @@ Stores an ordered pair of integers, which specify a and . - class is used to specify a height and width through the property for , , , and other graphics classes. You can perform operations on a by using the overloaded operators such as , , and . The unit for the and of the structure depend on the and settings for the object that is used to draw. - + structure is used to specify a height and width through the property for , , , and other graphics classes. You can perform operations on a by using the overloaded operators such as , , and . The unit for the and of the structure depend on the and settings for the object that is used to draw. + ]]> @@ -188,15 +189,15 @@ The height component of the new . Initializes a new instance of the structure from the specified dimensions. - and constructors and the enumeration. To run this example, paste this code into a Windows Form that contains a label named `Label1` and call the `InitializeLabel1` method in the form's constructor. - + and constructors and the enumeration. To run this example, paste this code into a Windows Form that contains a label named `Label1` and call the `InitializeLabel1` method in the form's constructor. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/CPP/form1.cpp" id="Snippet7"::: :::code language="csharp" source="~/snippets/csharp/System.Drawing/Color/Overview/form1.cs" id="Snippet7"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/VB/form1.vb" id="Snippet7"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/VB/form1.vb" id="Snippet7"::: + ]]> @@ -247,14 +248,14 @@ Adds the width and height of one structure to the width and height of another structure. A structure that is the result of the addition operation. - method. To run this example, paste it into a Windows Form. Handle the form's event and call the `AddSizes` method from the event-handling method, passing `e` as . - + method. To run this example, paste it into a Windows Form. Handle the form's event and call the `AddSizes` method from the event-handling method, passing `e` as . + :::code language="csharp" source="~/snippets/csharp/System.Drawing/CharacterRange/Equals/Form1.cs" id="Snippet11"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.MiscWhidbeySnippets/VB/Form1.vb" id="Snippet11"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.MiscWhidbeySnippets/VB/Form1.vb" id="Snippet11"::: + ]]> @@ -514,11 +515,11 @@ Returns a hash code for this structure. An integer value that specifies a hash value for this structure. - for unique values, as two objects with the same values for their and properties may return the same hash code. This behavior could change in a future release. - + for unique values, as two objects with the same values for their and properties may return the same hash code. This behavior could change in a future release. + ]]> @@ -578,11 +579,11 @@ Gets or sets the vertical component of this structure. The vertical component of this structure, typically measured in pixels. - and of the structure depend on the and settings for the object that is used to draw. - + and of the structure depend on the and settings for the object that is used to draw. + ]]> @@ -697,15 +698,15 @@ Adds the width and height of one structure to the width and height of another structure. A structure that is the result of the addition operation. - operator. The example is designed to be used with Windows Forms. To run this example, paste it into a form that contains a button named `addButton` and associate the `addButton_Click` method with the button's event. - + operator. The example is designed to be used with Windows Forms. To run this example, paste it into a form that contains a button named `addButton` and associate the `addButton_Click` method with the button's event. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/CPP/form1.cpp" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.Drawing/Color/Overview/form1.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/VB/form1.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/VB/form1.vb" id="Snippet4"::: + ]]> @@ -838,17 +839,17 @@ if and have equal width and height; otherwise, . - class. - - This example is designed to be used with Windows Forms. Create a form that contains a named `subtractButton`. Paste the code into the form and call the `CreatePointsAndSizes` method from the form's event-handling method, passing `e` as . - + class. + + This example is designed to be used with Windows Forms. Create a form that contains a named `subtractButton`. Paste the code into the form and call the `CreatePointsAndSizes` method from the form's event-handling method, passing `e` as . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/CPP/form1.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Drawing/Color/Overview/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/VB/form1.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/VB/form1.vb" id="Snippet1"::: + ]]> @@ -945,17 +946,17 @@ Converts the specified structure to a structure. The structure to which this operator converts. - , , , and properties of a and the member. - - This example is designed to be used with a Windows Form. Paste the code into the form and call the `ShowPropertiesOfSlateBlue` method from the form's event-handling method, passing `e` as . - + , , , and properties of a and the member. + + This example is designed to be used with a Windows Form. Paste the code into the form and call the `ShowPropertiesOfSlateBlue` method from the form's event-handling method, passing `e` as . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/CPP/form1.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Drawing/Color/Overview/form1.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/VB/form1.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/VB/form1.vb" id="Snippet3"::: + ]]> @@ -1229,15 +1230,15 @@ Subtracts the width and height of one structure from the width and height of another structure. A structure that is the result of the subtraction operation. - operator. The example is designed to be used with Windows Forms. To run the example, paste it into a form that contains a button named `subtractionButton` and associate the `subtractButton_Click` method with the button's event. - + operator. The example is designed to be used with Windows Forms. To run the example, paste it into a form that contains a button named `subtractionButton` and associate the `subtractButton_Click` method with the button's event. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/CPP/form1.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Drawing/Color/Overview/form1.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/VB/form1.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/VB/form1.vb" id="Snippet2"::: + ]]> @@ -1287,15 +1288,15 @@ Converts the specified structure to a structure by rounding the values of the structure to the nearest integer values. The structure this method converts to. - and methods to convert a to a . This example is designed to be used with Windows Forms. To run this example, paste it into a form that contains two objects named `Label1` and `Label2`, and then call this method from the form's constructor. - + and methods to convert a to a . This example is designed to be used with Windows Forms. To run this example, paste it into a form that contains two objects named `Label1` and `Label2`, and then call this method from the form's constructor. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/CPP/form1.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.Drawing/Color/Overview/form1.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/VB/form1.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/VB/form1.vb" id="Snippet5"::: + ]]> @@ -1346,14 +1347,14 @@ Subtracts the width and height of one structure from the width and height of another structure. A structure that is a result of the subtraction operation. - method. To run this example, paste it into a Windows Form. Handle the form's event and call the `SubtractSizes` method from the event-handling method, passing `e` as . - + method. To run this example, paste it into a Windows Form. Handle the form's event and call the `SubtractSizes` method from the event-handling method, passing `e` as . + :::code language="csharp" source="~/snippets/csharp/System.Drawing/CharacterRange/Equals/Form1.cs" id="Snippet12"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.MiscWhidbeySnippets/VB/Form1.vb" id="Snippet12"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.MiscWhidbeySnippets/VB/Form1.vb" id="Snippet12"::: + ]]> @@ -1459,15 +1460,15 @@ Converts the specified structure to a structure by truncating the values of the structure to the next lower integer values. The structure this method converts to. - and methods to convert a to a . This example is designed to be used with Windows Forms. To run this example, paste it into a form that contains two objects named `Label1` and `Label2`, and then call this method from the form's constructor. - + and methods to convert a to a . This example is designed to be used with Windows Forms. To run this example, paste it into a form that contains two objects named `Label1` and `Label2`, and then call this method from the form's constructor. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/CPP/form1.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.Drawing/Color/Overview/form1.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/VB/form1.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/VB/form1.vb" id="Snippet5"::: + ]]> @@ -1527,11 +1528,11 @@ Gets or sets the horizontal component of this structure. The horizontal component of this structure, typically measured in pixels. - and of the structure depend on the and settings for the object used to draw. - + and of the structure depend on the and settings for the object used to draw. + ]]> diff --git a/xml/System.IO/File.xml b/xml/System.IO/File.xml index 36859ba730c..723dcb8d453 100644 --- a/xml/System.IO/File.xml +++ b/xml/System.IO/File.xml @@ -5548,7 +5548,7 @@ The following example moves a file. 4.0.0.0 - Replaces the contents of a specified file with the contents of another file, deleting the original file, and creating a backup of the replaced file. + Replaces the contents of a specified file with the contents of another file, deleting the original file and creating a backup of the replaced file. field values on Windows and ## Remarks -This method is intended to concatenate individual strings into a single string that represents a file path. However, if an argument other than the first contains a rooted path, any previous path components are ignored, and the returned string begins with that rooted path component. As an alternative to the `Combine` method, consider using the or methods. +This method is intended to concatenate individual strings into a single string that represents a file path. However, if an argument other than the first contains a rooted path, any previous path components are ignored, and the returned string begins with that rooted path component. As an alternative to the `Combine` method, consider using the or methods (not available in .NET Framework). > [!IMPORTANT] > This method assumes that the first argument is an absolute path and that the following argument or arguments are relative paths. If this is not the case, and particularly if any subsequent arguments are strings input by the user, call the or method instead. diff --git a/xml/System.Text.Json/JsonSerializerOptions.xml b/xml/System.Text.Json/JsonSerializerOptions.xml index e6be2736252..b4ea9feda15 100644 --- a/xml/System.Text.Json/JsonSerializerOptions.xml +++ b/xml/System.Text.Json/JsonSerializerOptions.xml @@ -670,7 +670,7 @@ Read-only fields are not deserialized regardless of this setting. System.Boolean - Gets a value that indicates whether read-only properties are ignored during serialization. The default value is . + Gets or sets a value that indicates whether read-only properties are ignored during serialization. The default value is . if read-only properties are ignored during serialization; otherwise, . @@ -1178,10 +1178,10 @@ Use to enable un "System.Text.Json.Serialization.RespectNullableAnnotationsDefault" feature switch. - Nullability validation functions independently of required-ness validation, + Nullability validation functions independently of required-ness validation, that is to say the setting has no effect in scenarios where the payload is missing a required property. - This can be configured independently using the keyword, - the attribute, + This can be configured independently using the keyword, + the attribute, or the property. diff --git a/xml/System.Windows.Forms/ListView.xml b/xml/System.Windows.Forms/ListView.xml index 32fa3330da7..5a07fbdfa1c 100644 --- a/xml/System.Windows.Forms/ListView.xml +++ b/xml/System.Windows.Forms/ListView.xml @@ -80,7 +80,7 @@ If the property set to `true`, you can perform tasks such as validating the text being edited before and after the text changed by creating an event handler for the and events. To perform tasks such as opening a file or displaying a dialog box to edit an item displayed in a , you can create an event handler for the event. If you allow the user to sort the items in a when they click a column header, you can create an event handler for the event to perform the sorting. When the property is set to `true`, you can determine when a change in an item's check state has occurred by handling the event. - You can also set a background image for the with the property. Your application must have the on its `Main` method to correctly display the background image for the control. In addition, if a control with a background image is hosted in Internet Explorer, specify comctl32.dll version 6.0 as a dependent assembly in the application manifest file to ensure the background image is property displayed. + You can also set a background image for the with the property. Your application must have the on its `Main` method to correctly display the background image for the control. In addition, if a control with a background image is hosted in Internet Explorer, specify comctl32.dll version 6.0 as a dependent assembly in the application manifest file to ensure the background image is properly displayed. Windows XP and Windows Server 2003 provide three features that enhance the control when your application calls the method: tile view, grouping, and the insertion mark. diff --git a/xml/System.Xml.Serialization/IXmlSerializable.xml b/xml/System.Xml.Serialization/IXmlSerializable.xml index 8aca43fb4fa..88a73afd6e7 100644 --- a/xml/System.Xml.Serialization/IXmlSerializable.xml +++ b/xml/System.Xml.Serialization/IXmlSerializable.xml @@ -66,23 +66,23 @@ Provides custom formatting for XML serialization and deserialization. - . For example, you can chunk data into bytes instead of buffering large data sets, and also avoid the inflation that occurs when the data is encoded using Base64 encoding. To control the serialization, implement the and methods to control the and classes used to read and write the XML. For an example of this, see [How to: Chunk Serialized Data](/dotnet/standard/serialization/how-to-chunk-serialized-data). - - The second reason is to be able to control the schema. To enable this, you must apply the to the serializable type, and specify the name of the static member that returns the schema. See the for an example. - - A class that implements the interface must have a parameterless constructor. This is a requirement of the class. - - - -## Examples - The following example code shows an implementation of the interface that serializes a private field. - + . For example, you can chunk data into bytes instead of buffering large data sets, and also avoid the inflation that occurs when the data is encoded using Base64 encoding. To control the serialization, implement the and methods to control the and classes used to read and write the XML. For an example of this, see [How to: Chunk Serialized Data](/dotnet/standard/serialization/how-to-chunk-serialized-data). + + The second reason is to be able to control the schema. To enable this, you must apply the to the serializable type, and specify the name of the static member that returns the schema. See the for an example. + + A class that implements the interface must have a parameterless constructor. This is a requirement of the class. + + + +## Examples + The following example code shows an implementation of the interface that serializes a private field. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/XmlSerialization_IXmlSerializable/CPP/person.cpp" id="Snippet0"::: - :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/IXmlSerializable/Overview/person.cs" id="Snippet0"::: - + :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/IXmlSerializable/Overview/person.cs" id="Snippet0"::: + ]]> Introducing XML Serialization @@ -146,15 +146,15 @@ This method is reserved and should not be used. When implementing the interface, you should return ( in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the to the class. An that describes the XML representation of the object that is produced by the method and consumed by the method. - class does not perform XML validation. For this reason, it is often safe to omit schema information by providing a trivial implementation of this method, for example by returning `null` (`Nothing` in Visual Basic). - - If providing schema information is necessary, you should use the attribute. The `GetSchema` method should still return `null` (or `Nothing`). - - Some .NET Framework types as well as legacy custom types implementing the `IXmlSerializable` interface may be using `GetSchema` instead of `XmlSchemaProvider`. In this case, the method returns an accurate XML schema that describes the XML representation of the object generated by the method. - + class does not perform XML validation. For this reason, it is often safe to omit schema information by providing a trivial implementation of this method, for example by returning `null` (`Nothing` in Visual Basic). + + If providing schema information is necessary, you should use the attribute. The `GetSchema` method should still return `null` (or `Nothing`). + + Some .NET Framework types as well as legacy custom types implementing the `IXmlSerializable` interface may be using `GetSchema` instead of `XmlSchemaProvider`. In this case, the method returns an accurate XML schema that describes the XML representation of the object generated by the method. + ]]> @@ -208,28 +208,28 @@ The stream from which the object is deserialized. Generates an object from its XML representation. - method must reconstitute your object using the information that was written by the method. - - When this method is called, the reader is positioned on the start tag that wraps the information for your type. That is, directly on the start tag that indicates the beginning of a serialized object. When this method returns, it must have read the entire element from beginning to end, including all of its contents. Unlike the method, the framework does not handle the wrapper element automatically. Your implementation must do so. Failing to observe these positioning rules may cause code to generate unexpected runtime exceptions or corrupt data. - - When implementing this method, you should consider the possibility that a malicious user might provide a well-formed but invalid XML representation in order to disable or otherwise alter the behavior of your application. - - - -## Examples - The following example illustrates an implementation of the method. - + method must reconstitute your object using the information that was written by the method. + + When this method is called, the reader is positioned on the start tag that wraps the information for your type. That is, directly on the start tag that indicates the beginning of a serialized object. When this method returns, it must have read the entire element from beginning to end, including all of its contents. Unlike the method, the framework does not handle the wrapper element automatically. Your implementation must do so. Failing to observe these positioning rules may cause code to generate unexpected runtime exceptions or corrupt data. + + When implementing this method, you should consider the possibility that a malicious user might provide a well-formed but invalid XML representation in order to disable or otherwise alter the behavior of your application. + + + +## Examples + The following example illustrates an implementation of the method. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/XmlSerialization_IXmlSerializable/CPP/person.cpp" id="Snippet2"::: - :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/IXmlSerializable/Overview/person.cs" id="Snippet2"::: - - The following example illustrates the use of the class to deserialize this object. - + :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/IXmlSerializable/Overview/person.cs" id="Snippet2"::: + + The following example illustrates the use of the class to deserialize this object. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/XmlSerialization_IXmlSerializable/CPP/reader.cpp" id="Snippet20"::: - :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/IXmlSerializable/Overview/reader.cs" id="Snippet20"::: - + :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/IXmlSerializable/Overview/reader.cs" id="Snippet20"::: + ]]> @@ -283,28 +283,28 @@ The stream to which the object is serialized. Converts an object into its XML representation. - implementation you provide should write out the XML representation of the object. The framework writes a wrapper element and positions the XML writer after its start. Your implementation may write its contents, including child elements. The framework then closes the wrapper element. - - Write sufficient information to the stream to allow the method to reconstitute your object. - - For example, if your object state includes an array variable, be sure to write the length of the array, or use a parent element to contain the elements that describe the array values, so that you know how many values to read when the object is reconstituted. - - - -## Examples - The following example illustrates an implementation of the method. - + implementation you provide should write out the XML representation of the object. The framework writes a wrapper element and positions the XML writer after its start. Your implementation may write its contents, including child elements. The framework then closes the wrapper element. + + Write sufficient information to the stream to allow the method to reconstitute your object. + + For example, if your object state includes an array variable, be sure to write the length of the array, or use a parent element to contain the elements that describe the array values, so that you know how many values to read when the object is reconstituted. + + + +## Examples + The following example illustrates an implementation of the method. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/XmlSerialization_IXmlSerializable/CPP/person.cpp" id="Snippet1"::: - :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/IXmlSerializable/Overview/person.cs" id="Snippet1"::: - - The following example illustrates the use of the class to deserialize this object. - + :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/IXmlSerializable/Overview/person.cs" id="Snippet1"::: + + The following example illustrates the use of the class to serialize this object. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/XmlSerialization_IXmlSerializable/CPP/writer.cpp" id="Snippet10"::: - :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/IXmlSerializable/Overview/writer.cs" id="Snippet10"::: - + :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/IXmlSerializable/Overview/writer.cs" id="Snippet10"::: + ]]> From 85f5993df799785fcc9b065970f76d62a2603244 Mon Sep 17 00:00:00 2001 From: Sven Boemer Date: Wed, 28 Aug 2024 15:03:46 -0700 Subject: [PATCH 06/11] Add examples to FeatureGuard/FeatureSwitchDefinition docs (#10304) --- .../FeatureGuardAttribute.xml | 34 +++++++++++++++--- .../FeatureSwitchDefinitionAttribute.xml | 35 ++++++++++++++++--- 2 files changed, 60 insertions(+), 9 deletions(-) diff --git a/xml/System.Diagnostics.CodeAnalysis/FeatureGuardAttribute.xml b/xml/System.Diagnostics.CodeAnalysis/FeatureGuardAttribute.xml index d5a85d51400..aa4efe29a6f 100644 --- a/xml/System.Diagnostics.CodeAnalysis/FeatureGuardAttribute.xml +++ b/xml/System.Diagnostics.CodeAnalysis/FeatureGuardAttribute.xml @@ -29,14 +29,38 @@ - Indicates that the specified public static boolean get-only property - guards access to the specified feature. + + Indicates that the specified public static Boolean read-only property + guards access to the specified feature. - Analyzers can use this to prevent warnings on calls to code that is - annotated as requiring that feature, when the callsite is guarded by a - call to the property. + + Analyzers can use this attribute to prevent warnings on calls to code that's + annotated as requiring that feature, when the callsite is guarded by a + call to the property. + + RuntimeFeature.IsDynamicCodeSupported; + + [RequiresDynamicCode("Feature requires dynamic code support.")] + internal static Implementation() => ...; // Uses dynamic code +} +``` + +When the app is built with `true`, the call to +`Feature.Implementation()` doesn't produce analyzer warning +[IL3050](/dotnet/core/deploying/native-aot/warnings/il3050) +and `Feature.Implementation` code is removed when publishing. +]]> + diff --git a/xml/System.Diagnostics.CodeAnalysis/FeatureSwitchDefinitionAttribute.xml b/xml/System.Diagnostics.CodeAnalysis/FeatureSwitchDefinitionAttribute.xml index cf8b0e4ee20..c8f6111e6c8 100644 --- a/xml/System.Diagnostics.CodeAnalysis/FeatureSwitchDefinitionAttribute.xml +++ b/xml/System.Diagnostics.CodeAnalysis/FeatureSwitchDefinitionAttribute.xml @@ -29,13 +29,40 @@ - Indicates that the specified public static boolean get-only property - corresponds to the feature switch specified by name. + + Indicates that the specified public static Boolean read-only property + corresponds to the feature switch specified by name. - IL rewriters and compilers can use this to substitute the return value - of the specified property with the value of the feature switch. + + IL rewriters and compilers can use this attribute to substitute the return value + of the specified property with the value of the feature switch. + + AppContext.TryGetSwitch("Feature.IsSupported", out bool isEnabled) ? isEnabled : true; + + internal static Implementation() => ...; +} +``` + +When the app is trimmed with the following feature settings in the project file, +`Feature.IsSupported` is treated as `false`, and `Feature.Implementation` code is removed. + +```xml + + + +``` +]]> + From da89a62d3a49691ca6ad66cb004bf05139335f50 Mon Sep 17 00:00:00 2001 From: Ken Dale <1012917+kendaleiv@users.noreply.github.com> Date: Wed, 28 Aug 2024 18:16:57 -0400 Subject: [PATCH 07/11] Updates to remove unexpected ) characters, trim nearby spaces (#10195) Update to remove unexpected `)` characters that don't have a matching `(` character. Also, trim unnecessary nearby spaces. --- xml/System.ServiceModel.Security/SecurityMessageProperty.xml | 4 ++-- xml/System.ServiceModel/EndpointIdentity.xml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/xml/System.ServiceModel.Security/SecurityMessageProperty.xml b/xml/System.ServiceModel.Security/SecurityMessageProperty.xml index 9912fe213b2..030d9e4d477 100644 --- a/xml/System.ServiceModel.Security/SecurityMessageProperty.xml +++ b/xml/System.ServiceModel.Security/SecurityMessageProperty.xml @@ -104,8 +104,8 @@ , such as , , or ), a copy must be created because these properties are undefined after the message is disposed of. - + To access any objects in the , such as , , or , a copy must be created because these properties are undefined after the message is disposed of. + ]]> diff --git a/xml/System.ServiceModel/EndpointIdentity.xml b/xml/System.ServiceModel/EndpointIdentity.xml index 256201b1fcb..76b5116f92a 100644 --- a/xml/System.ServiceModel/EndpointIdentity.xml +++ b/xml/System.ServiceModel/EndpointIdentity.xml @@ -665,7 +665,7 @@ ). + This method is called by the constructors of all the classes derived from . ]]> From b2a4028672c4307eff1b492963efeab3b14d49ed Mon Sep 17 00:00:00 2001 From: Edward Neal <55035479+edwardneal@users.noreply.github.com> Date: Wed, 28 Aug 2024 23:17:53 +0100 Subject: [PATCH 08/11] Update ZipArchive.xml, ZipFile.xml (#10193) Changed references to entryNameEncoding to clarify that it changes the encoding and decoding of both entry names and comments. --- ..._Stream_ZipArchiveMode_Boolean_Encoding.md | 20 ++++---- .../System.IO.Compression/ZipFile/Open.md | 20 ++++---- xml/System.IO.Compression/ZipArchive.xml | 2 +- xml/System.IO.Compression/ZipFile.xml | 46 +++++++++---------- 4 files changed, 44 insertions(+), 44 deletions(-) diff --git a/includes/remarks/System.IO.Compression/ZipArchive/.ctor_Stream_ZipArchiveMode_Boolean_Encoding.md b/includes/remarks/System.IO.Compression/ZipArchive/.ctor_Stream_ZipArchiveMode_Boolean_Encoding.md index dc5e6529c83..c2769c4f11b 100644 --- a/includes/remarks/System.IO.Compression/ZipArchive/.ctor_Stream_ZipArchiveMode_Boolean_Encoding.md +++ b/includes/remarks/System.IO.Compression/ZipArchive/.ctor_Stream_ZipArchiveMode_Boolean_Encoding.md @@ -1,21 +1,21 @@ If the `mode` parameter is set to , the stream must support reading. If the `mode` parameter is set to , the stream must support writing. If the `mode` parameter is set to , the stream must support reading, writing, and seeking. -When you open a zip archive file for reading and `entryNameEncoding` is set to `null`, entry names are decoded according to the following rules: +When you open a zip archive file for reading and `entryNameEncoding` is set to `null`, entry names and comments are decoded according to the following rules: -- When the language encoding flag (in the general-purpose bit flag of the local file header) is not set, the current system default code page is used to decode the entry name. +- When the language encoding flag (in the general-purpose bit flag of the local file header) is not set, the current system default code page is used to decode the entry name and comment. -- When the language encoding flag is set, UTF-8 is used to decode the entry name. +- When the language encoding flag is set, UTF-8 is used to decode the entry name and comment. -When you open a zip archive file for reading and `entryNameEncoding` is set to a value other than `null`, entry names are decoded according to the following rules: +When you open a zip archive file for reading and `entryNameEncoding` is set to a value other than `null`, entry names and comments are decoded according to the following rules: -- When the language encoding flag is not set, the specified `entryNameEncoding` is used to decode the entry name. +- When the language encoding flag is not set, the specified `entryNameEncoding` is used to decode the entry name and comment. -- When the language encoding flag is set, UTF-8 is used to decode the entry name. +- When the language encoding flag is set, UTF-8 is used to decode the entry name and comment. -When you write to archive files and `entryNameEncoding` is set to `null`, entry names are encoded according to the following rules: +When you write to archive files and `entryNameEncoding` is set to `null`, entry names and comments are encoded according to the following rules: -- For entry names that contain characters outside the ASCII range, the language encoding flag is set, and entry names are encoded by using UTF-8. +- For entry names and comments that contain characters outside the ASCII range, the language encoding flag is set, and entry names and comments are encoded by using UTF-8. -- For entry names that contain only ASCII characters, the language encoding flag is not set, and entry names are encoded by using the current system default code page. +- For entry names and comments that contain only ASCII characters, the language encoding flag is not set, and entry names and comments are encoded by using the current system default code page. -When you write to archive files and `entryNameEncoding` is set to a value other than `null`, the specified `entryNameEncoding` is used to encode the entry names into bytes. The language encoding flag (in the general-purpose bit flag of the local file header) is set only when the specified encoding is a UTF-8 encoding. +When you write to archive files and `entryNameEncoding` is set to a value other than `null`, the specified `entryNameEncoding` is used to encode the entry names and comments into bytes. The language encoding flag (in the general-purpose bit flag of the local file header) is set only when the specified encoding is a UTF-8 encoding. diff --git a/includes/remarks/System.IO.Compression/ZipFile/Open.md b/includes/remarks/System.IO.Compression/ZipFile/Open.md index 83fc67a82b7..15ba399c87f 100644 --- a/includes/remarks/System.IO.Compression/ZipFile/Open.md +++ b/includes/remarks/System.IO.Compression/ZipFile/Open.md @@ -4,22 +4,22 @@ When you set the `mode` parameter to , the archive is opened with as the file mode value. If the archive exists, it is opened. The existing entries can be modified and new entries can be created. If the archive does not exist, a new archive is created; however, creating a zip archive in mode is not as efficient as creating it in mode. -When you open a zip archive file for reading and `entryNameEncoding` is set to `null`, entry names are decoded according to the following rules: +When you open a zip archive file for reading and `entryNameEncoding` is set to `null`, entry names and comments are decoded according to the following rules: -- When the language encoding flag (in the general-purpose bit flag of the local file header) is not set, the current system default code page is used to decode the entry name. +- When the language encoding flag (in the general-purpose bit flag of the local file header) is not set, the current system default code page is used to decode the entry name and comment. -- When the language encoding flag is set, UTF-8 is used to decode the entry name. +- When the language encoding flag is set, UTF-8 is used to decode the entry name and comment. -When you open a zip archive file for reading and `entryNameEncoding` is set to a value other than `null`, entry names are decoded according to the following rules: +When you open a zip archive file for reading and `entryNameEncoding` is set to a value other than `null`, entry names and comments are decoded according to the following rules: -- When the language encoding flag is not set, the specified `entryNameEncoding` is used to decode the entry name. +- When the language encoding flag is not set, the specified `entryNameEncoding` is used to decode the entry name and comment. -- When the language encoding flag is set, UTF-8 is used to decode the entry name. +- When the language encoding flag is set, UTF-8 is used to decode the entry name and comment. -When you write to archive files and `entryNameEncoding` is set to `null`, entry names are encoded according to the following rules: +When you write to archive files and `entryNameEncoding` is set to `null`, entry names and comments are encoded according to the following rules: -- For entry names that contain characters outside the ASCII range, the language encoding flag is set, and entry names are encoded by using UTF-8. +- For entry names or comments that contain characters outside the ASCII range, the language encoding flag is set, and entry names and comments are encoded by using UTF-8. -- For entry names that contain only ASCII characters, the language encoding flag is not set, and entry names are encoded by using the current system default code page. +- For entry names or comments that contain only ASCII characters, the language encoding flag is not set, and entry names and comments are encoded by using the current system default code page. -When you write to archive files and `entryNameEncoding` is set to a value other than `null`, the specified `entryNameEncoding` is used to encode the entry names into bytes. The language encoding flag (in the general-purpose bit flag of the local file header) is set only when the specified encoding is a UTF-8 encoding. +When you write to archive files and `entryNameEncoding` is set to a value other than `null`, the specified `entryNameEncoding` is used to encode the entry names and comments into bytes. The language encoding flag (in the general-purpose bit flag of the local file header) is set only when the specified encoding is a UTF-8 encoding. diff --git a/xml/System.IO.Compression/ZipArchive.xml b/xml/System.IO.Compression/ZipArchive.xml index 7b13915d34d..22d78b01d51 100644 --- a/xml/System.IO.Compression/ZipArchive.xml +++ b/xml/System.IO.Compression/ZipArchive.xml @@ -276,7 +276,7 @@ One of the enumeration values that indicates whether the zip archive is used to read, create, or update entries. to leave the stream open after the object is disposed; otherwise, . - The encoding to use when reading or writing entry names in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names. + The encoding to use when reading or writing entry names and comments in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names or comments. Initializes a new instance of the class on the specified stream for the specified mode, uses the specified encoding for entry names, and optionally leaves the stream open. One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry. to include the directory name from at the root of the archive; to include only the contents of the directory. - The encoding to use when reading or writing entry names in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names. - Creates a zip archive in the specified stream that contains the files and directories from the specified directory, uses the specified compression level and character encoding for entry names, and optionally includes the base directory. + The encoding to use when reading or writing entry names and comments in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names or comments. + Creates a zip archive in the specified stream that contains the files and directories from the specified directory, uses the specified compression level and character encoding for entry names and comments, and optionally includes the base directory. The directory structure from the file system is preserved in the archive. If the directory is empty, an empty archive is created. Use this method overload to specify the compression level and character encoding, and whether to include the base directory in the archive. If a file in the directory cannot be added to the archive, the archive is left incomplete and invalid, and the method throws an exception. @@ -488,8 +488,8 @@ An I/O error occurred while opening a file to be archived. One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry. to include the directory name from at the root of the archive; to include only the contents of the directory. - The encoding to use when reading or writing entry names in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names. - Creates a zip archive that contains the files and directories from the specified directory, uses the specified compression level and character encoding for entry names, and optionally includes the base directory. + The encoding to use when reading or writing entry names and comments in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names or comments. + Creates a zip archive that contains the files and directories from the specified directory, uses the specified compression level and character encoding for entry names and comments, and optionally includes the base directory. If a file in the directory cannot be added to the archive, the archive is left incomplete and invalid, and the method throws an exception. - If `entryNameEncoding` is set to a value other than `null`, the entry names are encoded by using the specified encoding. If the specified encoding is a UTF-8, the language encoding flag (in the general-purpose bit flag of the local file header) is set for each entry, + If `entryNameEncoding` is set to a value other than `null`, the entry names and comments are encoded by using the specified encoding. If the specified encoding is a UTF-8 encoding, the language encoding flag (in the general-purpose bit flag of the local file header) is set for each entry. - If `entryNameEncoding` is set to `null`, the entry names are encoded according to the following rules: + If `entryNameEncoding` is set to `null`, the entry names and comments are encoded according to the following rules: -- For entry names that contain characters outside the ASCII range, the language encoding flag is set, and UTF-8 is used to encode the entry name. +- For entry names and comments that contain characters outside the ASCII range, the language encoding flag is set, and UTF-8 is used to encode the entry name and comment. -- For entry names that contain only ASCII characters, the language encoding flag is set, and the current system default code page is used to encode the entry names. +- For entry names and comments that contain only ASCII characters, the language encoding flag is not set, and the current system default code page is used to encode the entry names and comments. ]]> @@ -800,8 +800,8 @@ An archive entry was compressed by using a compression method that is not suppor The stream from which the zip archive is to be extracted. The path to the directory in which to place the extracted files, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory. - The encoding to use when reading or writing entry names in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names. - Extracts all the files from the zip archive stored in the specified stream and places them in the specified destination directory on the file system and uses the specified character encoding for entry names. + The encoding to use when reading or writing entry names and comments in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names or comments. + Extracts all the files from the zip archive stored in the specified stream and places them in the specified destination directory on the file system and uses the specified character encoding for entry names and comments. This method creates the specified directory and all subdirectories. The destination directory cannot already exist. Exceptions related to validating the paths in the or the files in the zip archive contained in parameters are thrown before extraction. Otherwise, if an error occurs during extraction, the archive remains partially extracted. Each extracted file has the same relative path to the directory specified by as its source entry has to the root of the archive. @@ -986,8 +986,8 @@ A has been compressed usi The path to the archive that is to be extracted. The path to the directory in which to place the extracted files, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory. - The encoding to use when reading or writing entry names in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names. - Extracts all the files in the specified zip archive to a directory on the file system and uses the specified character encoding for entry names. + The encoding to use when reading or writing entry names and comments in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names or comments. + Extracts all the files in the specified zip archive to a directory on the file system and uses the specified character encoding for entry names and comments. has been compressed usi This method creates the specified directory and all subdirectories, if necessary. Exceptions related to validating the paths in the `destinationDirectoryName` or `sourceArchiveFileName` parameters are thrown before extraction. Otherwise, if an error occurs during extraction, the archive remains partially extracted. Each extracted file has the same relative path to the directory specified by `destinationDirectoryName` as its source entry has to the root of the archive. -If `entryNameEncoding` is set to a value other than `null`, entry names are decoded according to the following rules: +If `entryNameEncoding` is set to a value other than `null`, entry names and comments are decoded according to the following rules: -- For entry names where the language encoding flag (in the general-purpose bit flag of the local file header) is not set, the entry names are decoded by using the specified encoding. -- For entries where the language encoding flag is set, the entry names are decoded by using UTF-8. +- For entries where the language encoding flag (in the general-purpose bit flag of the local file header) is not set, the entry names and comments are decoded by using the specified encoding. +- For entries where the language encoding flag is set, the entry names and comments are decoded by using UTF-8. -If `entryNameEncoding` is set to `null`, entry names are decoded according to the following rules: +If `entryNameEncoding` is set to `null`, entry names and comments are decoded according to the following rules: -- For entries where the language encoding flag (in the general-purpose bit flag of the local file header) is not set, entry names are decoded by using the current system default code page. -- For entries where the language encoding flag is set, the entry names are decoded by using UTF-8. +- For entries where the language encoding flag (in the general-purpose bit flag of the local file header) is not set, entry names and comments are decoded by using the current system default code page. +- For entries where the language encoding flag is set, the entry names and comments are decoded by using UTF-8. ]]> @@ -1077,10 +1077,10 @@ If `entryNameEncoding` is set to `null`, entry names are decoded according to th The stream from which the zip archive is to be extracted. The path to the directory in which to place the extracted files, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory. - The encoding to use when reading or writing entry names in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names. + The encoding to use when reading or writing entry names and comments in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names or comments. to overwrite files; otherwise. - Extracts all the files from the zip archive stored in the specified stream and places them in the specified destination directory on the file system, uses the specified character encoding for entry names, and optionally allows choosing if the files in the destination directory should be overwritten. + Extracts all the files from the zip archive stored in the specified stream and places them in the specified destination directory on the file system, uses the specified character encoding for entry names and comments, and optionally allows choosing if the files in the destination directory should be overwritten. This method creates the specified directory and all subdirectories. The destination directory cannot already exist. Exceptions related to validating the paths in the or the files in the zip archive contained in parameters are thrown before extraction. Otherwise, if an error occurs during extraction, the archive remains partially extracted. Each extracted file has the same relative path to the directory specified by as its source entry has to the root of the archive. @@ -1164,7 +1164,7 @@ An archive entry was compressed by using a compression method that is not suppor The path on the file system to the archive that is to be extracted. The path to the destination directory on the file system. - The encoding to use when reading entry names in this . + The encoding to use when reading entry names and comments in this . to overwrite files; otherwise. Extracts all of the files in the specified archive to a directory on the file system. @@ -1391,8 +1391,8 @@ An unspecified I/O error occurred while opening the file. The path to the archive to open, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory. One of the enumeration values that specifies the actions that are allowed on the entries in the opened archive. - The encoding to use when reading or writing entry names in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names. - Opens a zip archive at the specified path, in the specified mode, and by using the specified character encoding for entry names. + The encoding to use when reading or writing entry names and comments in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names or comments. + Opens a zip archive at the specified path, in the specified mode, and by using the specified character encoding for entry names and comments. The opened zip archive. Date: Wed, 28 Aug 2024 15:19:26 -0700 Subject: [PATCH 09/11] Update PipeWriter.xml (#10260) --- xml/System.IO.Pipelines/PipeWriter.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.IO.Pipelines/PipeWriter.xml b/xml/System.IO.Pipelines/PipeWriter.xml index c362f276c84..f9b3ff74039 100644 --- a/xml/System.IO.Pipelines/PipeWriter.xml +++ b/xml/System.IO.Pipelines/PipeWriter.xml @@ -72,7 +72,7 @@ The number of bytes written to the or . - Notifies the that bytes were written to the output or . You must request a new buffer after calling to continue writing more data; you cannot write to a previously acquired buffer. + Notifies the that bytes were written to the output or . You must call or again and use the returned buffer to continue writing more data after calling ; you cannot write to a previously acquired buffer. To be added. From 0bb5c05ad477d5cd02e1869ba39847efe3aa76ca Mon Sep 17 00:00:00 2001 From: tfenise Date: Thu, 29 Aug 2024 02:10:40 +0200 Subject: [PATCH 10/11] Update BigInteger.xml (#10021) --- xml/System.Numerics/BigInteger.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Numerics/BigInteger.xml b/xml/System.Numerics/BigInteger.xml index 9cce604dd76..adbc873b145 100644 --- a/xml/System.Numerics/BigInteger.xml +++ b/xml/System.Numerics/BigInteger.xml @@ -2218,7 +2218,7 @@ This method returns 0 if the value of current object is equal to [!NOTE] > Computing the greatest common divisor of very large values of `left` and `right` can be a very time-consuming operation. - The value returned by the method is always positive regardless of the sign of the `left` and `right` parameters. + The value returned by the method is always positive (including zero) regardless of the sign of the `left` and `right` parameters. From c88c7de4f7f5c9328a0e9d9c3879ad95cbb81f87 Mon Sep 17 00:00:00 2001 From: zacharylayne Date: Wed, 28 Aug 2024 17:50:16 -0700 Subject: [PATCH 11/11] Update sample.cs (#8741) * Update sample.cs - Fix first if-statement in Create method: currently checks to see if `nameValue == null` **and** `nameValue.Length == 0`. Should check if one or the other. - Change exception thrown from above if-statement from `ArgumentNullException` to `ArgumentException` and replaced argument with `nameof` expression. - Remove unnecessary empty lines. * Apply suggestions from code review --------- Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- .../SafeWaitHandle/Overview/sample.cs | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/snippets/csharp/Microsoft.Win32.SafeHandles/SafeWaitHandle/Overview/sample.cs b/snippets/csharp/Microsoft.Win32.SafeHandles/SafeWaitHandle/Overview/sample.cs index 29beb85b7dd..14239f863b2 100644 --- a/snippets/csharp/Microsoft.Win32.SafeHandles/SafeWaitHandle/Overview/sample.cs +++ b/snippets/csharp/Microsoft.Win32.SafeHandles/SafeWaitHandle/Overview/sample.cs @@ -5,14 +5,12 @@ class SafeHandlesExample { - static void Main() { UnmanagedMutex uMutex = new UnmanagedMutex("YourCompanyName_SafeHandlesExample_MUTEX"); try { - uMutex.Create(); Console.WriteLine("Mutex created. Press Enter to release it."); Console.ReadLine(); @@ -58,10 +56,7 @@ public UnmanagedMutex(string Name) public void Create() { - if (nameValue == null && nameValue.Length == 0) - { - throw new ArgumentNullException("nameValue"); - } + ArgumentException.ThrowIfNullOrEmpty(nameValue); handleValue = CreateMutex(mutexAttrValue, true, nameValue); @@ -105,4 +100,4 @@ public void Release() ReleaseMutex(handleValue); } } -// \ No newline at end of file +//