Back to Dotnet

List of Diagnostics Produced by .NET Libraries APIs

docs/project/list-of-diagnostics.md

11.0.10033.4 KB
Original Source

List of Diagnostics Produced by .NET Libraries APIs

Obsoletions

Per https://github.com/dotnet/designs/blob/master/accepted/2020/better-obsoletion/better-obsoletion.md, we now have a strategy for marking existing APIs as [Obsolete]. This takes advantage of the new diagnostic id and URL template mechanisms introduced to ObsoleteAttribute in .NET 5.

The diagnostic id values reserved for obsoletions are SYSLIB0001 through SYSLIB0999. When obsoleting an API, claim the next three-digit identifier in the SYSLIB0### sequence and add it to the list below. The URL template for all obsoletions is https://aka.ms/dotnet-warnings/{0}. The {0} placeholder is replaced by the compiler with the SYSLIB0### identifier.

The acceptance criteria for adding an obsoletion includes:

  • Add the obsoletion to the table below, claiming the next diagnostic id
    • Ensure the description is meaningful within the context of this table, and without requiring the context of the calling code
  • Add new constants to src\libraries\Common\src\System\Obsoletions.cs, following the existing conventions
    • A ...Message const using the same description added to the table below
    • A ...DiagId const for the SYSLIB0### id
  • Annotate src files by referring to the constants defined from Obsoletions.cs
    • Specify the UrlFormat = Obsoletions.SharedUrlFormat
    • Example: [Obsolete(Obsoletions.CodeAccessSecurityMessage, DiagnosticId = Obsoletions.CodeAccessSecurityDiagId, UrlFormat = Obsoletions.SharedUrlFormat)]
    • If the Obsoletions type is not available in the project, link it into the project
      • <Compile Include="$(CommonPath)System\Obsoletions.cs" Link="Common\System\Obsoletions.cs" />
  • Annotate ref files using the hard-coded strings copied from Obsoletions.cs
    • This matches our general pattern of ref files using hard-coded attribute strings
    • Example: [System.ObsoleteAttribute("The UTF-7 encoding is insecure and should not be used. Consider using UTF-8 instead.", DiagnosticId = "SYSLIB0001", UrlFormat = "https://aka.ms/dotnet-warnings/{0}")]
  • If the library builds against downlevel targets earlier than .NET 5.0, then add an internal copy of ObsoleteAttribute
    • The compiler recognizes internal implementations of ObsoleteAttribute to enable the DiagnosticId and UrlFormat properties to light up downlevel
    • An MSBuild property can be added to the project's first <PropertyGroup> to achieve this easily
    • Example: <IncludeInternalObsoleteAttribute>true</IncludeInternalObsoleteAttribute>
    • This will need to be specified in both the src and ref projects
  • If the library contains types that are forwarded within a generated shim
    • Errors will be received when running build libs, with obsoletion errors in src/libraries/shims/generated files
    • This is resolved by adding the obsoletion's diagnostic id to the <NoWarn> property for partial facade assemblies
    • That property is found in src/libraries/Directory.Build.targets
    • Search for the "Ignore Obsolete errors within the generated shims that type-forward types" comment and add the appropriate diagnostic id to the comment and the <NoWarn> property (other SYSLIB diagnostics already exist there)
  • Apply the breaking-change label to the PR that introduces the obsoletion
    • A bot will automatically apply the needs-breaking-change-doc-created label when the breaking-change label is detected
  • Follow up with the breaking change process to communicate and document the breaking change
    • In the breaking-change issue filed in dotnet/docs, specifically mention that this breaking change is an obsoletion with a SYSLIB diagnostic id
    • The documentation team will produce a PR that adds the obsoletion to the SYSLIB warnings page
    • That PR will also add a new URL specific to this diagnostic ID; e.g. SYSLIB0001
    • Connect with @gewarren or @BillWagner with any questions
  • Register the SYSLIB0### URL in aka.ms
    • The vanity name will be dotnet-warnings/syslib0###
    • Ensure the link's group owner matches the group owner of dotnet-warnings/syslib0001
    • Connect with @jeffhandley, @GrabYourPitchforks, or @gewarren with any questions

An example obsoletion PR that can be referenced where each of the above criteria was met is:

The PR that reveals the implementation of the <IncludeInternalObsoleteAttribute> property was:

Obsoletion Diagnostics (SYSLIB0001 - SYSLIB0999)

Diagnostic IDDescription
SYSLIB0001The UTF-7 encoding is insecure and should not be used. Consider using UTF-8 instead.
SYSLIB0002PrincipalPermissionAttribute is not honored by the runtime and must not be used.
SYSLIB0003Code Access Security is not supported or honored by the runtime.
SYSLIB0004The Constrained Execution Region (CER) feature is not supported.
SYSLIB0005The Global Assembly Cache is not supported.
SYSLIB0006Thread.Abort is not supported and throws PlatformNotSupportedException.
SYSLIB0007The default implementation of this cryptography algorithm is not supported.
SYSLIB0008The CreatePdbGenerator API is not supported and throws PlatformNotSupportedException.
SYSLIB0009AuthenticationManager is not supported. Methods will no-op or throw PlatformNotSupportedException.
SYSLIB0010This Remoting API is not supported and throws PlatformNotSupportedException.
SYSLIB0011BinaryFormatter serialization is obsolete and should not be used. See https://aka.ms/binaryformatter for recommended alternatives.
SYSLIB0012Assembly.CodeBase and Assembly.EscapedCodeBase are only included for .NET Framework compatibility. Use Assembly.Location instead.
SYSLIB0013Uri.EscapeUriString can corrupt the Uri string in some cases. Consider using Uri.EscapeDataString for query string components instead.
SYSLIB0014WebRequest, HttpWebRequest, ServicePoint, and WebClient are obsolete. Use HttpClient instead.
SYSLIB0015DisablePrivateReflectionAttribute has no effect in .NET 6.0+.
SYSLIB0016Use the Graphics.GetContextInfo overloads that accept arguments for better performance and fewer allocations.
SYSLIB0017Strong name signing is not supported and throws PlatformNotSupportedException.
SYSLIB0018ReflectionOnly loading is not supported and throws PlatformNotSupportedException.
SYSLIB0019RuntimeEnvironment members SystemConfigurationFile, GetRuntimeInterfaceAsIntPtr, and GetRuntimeInterfaceAsObject are not supported and throw PlatformNotSupportedException.
SYSLIB0020JsonSerializerOptions.IgnoreNullValues is obsolete. To ignore null values when serializing, set DefaultIgnoreCondition to JsonIgnoreCondition.WhenWritingNull.
SYSLIB0021Derived cryptographic types are obsolete. Use the Create method on the base type instead.
SYSLIB0022The Rijndael and RijndaelManaged types are obsolete. Use Aes instead.
SYSLIB0023RNGCryptoServiceProvider is obsolete. To generate a random number, use one of the RandomNumberGenerator static methods instead.
SYSLIB0024Creating and unloading AppDomains is not supported and throws an exception.
SYSLIB0025SuppressIldasmAttribute has no effect in .NET 6.0+.
SYSLIB0026X509Certificate and X509Certificate2 are immutable. Use X509CertificateLoader to create a new certificate.
SYSLIB0027PublicKey.Key is obsolete. Use the appropriate method to get the public key, such as GetRSAPublicKey.
SYSLIB0028X509Certificate2.PrivateKey is obsolete. Use the appropriate method to get the private key, such as GetRSAPrivateKey, or use the CopyWithPrivateKey method to create a new instance with a private key.
SYSLIB0029ProduceLegacyHmacValues is obsolete. Producing legacy HMAC values is not supported.
SYSLIB0030HMACSHA1 always uses the algorithm implementation provided by the platform. Use a constructor without the useManagedSha1 parameter.
SYSLIB0031EncodeOID is obsolete. Use the ASN.1 functionality provided in System.Formats.Asn1.
SYSLIB0032Recovery from corrupted process state exceptions is not supported; HandleProcessCorruptedStateExceptionsAttribute is ignored.
SYSLIB0033Rfc2898DeriveBytes.CryptDeriveKey is obsolete and is not supported. Use PasswordDeriveBytes.CryptDeriveKey instead.
SYSLIB0034CmsSigner(CspParameters) is obsolete and is not supported. Use an alternative constructor instead.
SYSLIB0035ComputeCounterSignature without specifying a CmsSigner is obsolete and is not supported. Use the overload that accepts a CmsSigner.
SYSLIB0036Regex.CompileToAssembly is obsolete and not supported. Use GeneratedRegexAttribute with the regular expression source generator instead.
SYSLIB0037AssemblyName members HashAlgorithm, ProcessorArchitecture, and VersionCompatibility are obsolete and not supported.
SYSLIB0038SerializationFormat.Binary is obsolete and should not be used. See https://aka.ms/serializationformat-binary-obsolete for more information.
SYSLIB0039TLS versions 1.0 and 1.1 have known vulnerabilities and are not recommended. Use a newer TLS version instead, or use SslProtocols.None to defer to OS defaults.
SYSLIB0040EncryptionPolicy.NoEncryption and AllowEncryption significantly reduce security and should not be used in production code.
SYSLIB0041The default hash algorithm and iteration counts in Rfc2898DeriveBytes constructors are outdated and insecure. Use a constructor that accepts the hash algorithm and the number of iterations.
SYSLIB0042ToXmlString and FromXmlString have no implementation for ECC types, and are obsolete. Use a standard import and export format such as ExportSubjectPublicKeyInfo or ImportSubjectPublicKeyInfo for public keys and ExportPkcs8PrivateKey or ImportPkcs8PrivateKey for private keys.
SYSLIB0043ECDiffieHellmanPublicKey.ToByteArray() and the associated constructor do not have a consistent and interoperable implementation on all platforms. Use ECDiffieHellmanPublicKey.ExportSubjectPublicKeyInfo() instead.
SYSLIB0044AssemblyName.CodeBase and AssemblyName.EscapedCodeBase are obsolete. Using them for loading an assembly is not supported.
SYSLIB0045Cryptographic factory methods accepting an algorithm name are obsolete. Use the parameterless Create factory method on the algorithm type instead.
SYSLIB0046ControlledExecution.Run method may corrupt the process and should not be used in production code.
SYSLIB0047XmlSecureResolver is obsolete. Use XmlResolver.ThrowingResolver instead when attempting to forbid XML external entity resolution.
SYSLIB0048RSA.EncryptValue and DecryptValue are not supported and throw NotSupportedException. Use RSA.Encrypt and RSA.Decrypt instead.
SYSLIB0049JsonSerializerOptions.AddContext is obsolete. To register a JsonSerializerContext, use either the TypeInfoResolver or TypeInfoResolverChain properties.
SYSLIB0050Formatter-based serialization is obsolete and should not be used.
SYSLIB0051This API supports obsolete formatter-based serialization. It should not be called or extended by application code.
SYSLIB0052This API supports obsolete mechanisms for Regex extensibility. It is not supported.
SYSLIB0053AesGcm should indicate the required tag size for encryption and decryption. Use a constructor that accepts the tag size.
SYSLIB0054Thread.VolatileRead and Thread.VolatileWrite are obsolete. Use Volatile.Read or Volatile.Write respectively instead.
SYSLIB0055The underlying hardware instruction does not perform a signed saturate narrowing operation, and it always returns an unsigned result. Use the unsigned overload instead.
SYSLIB0056LoadFrom with a custom AssemblyHashAlgorithm is obsolete. Use overloads without an AssemblyHashAlgorithm.
SYSLIB0057Loading certificate data through the constructor or Import is obsolete. Use X509CertificateLoader instead to load certificates.
SYSLIB0058KeyExchangeAlgorithm, KeyExchangeStrength, CipherAlgorithm, CipherStrength, HashAlgorithm and HashStrength properties of SslStream are obsolete. Use NegotiatedCipherSuite instead.
SYSLIB0059SystemEvents.EventsThreadShutdown callbacks are not run before the process exits. Use AppDomain.ProcessExit instead.
SYSLIB0060The constructors on Rfc2898DeriveBytes are obsolete. Use the static Pbkdf2 method instead.
SYSLIB0061The Queryable MinBy and MaxBy taking an IComparer<TSource> are obsolete. Use the new ones that take an IComparer<TKey>.
SYSLIB0062XSLT Script blocks are not supported.
SYSLIB0063This constructor has been deprecated and argument bool isConnected does not have any effect. Use NamedPipeClientStream(PipeDirection direction, bool isAsync, SafePipeHandle safePipeHandle) instead.
SYSLIB0064RSACryptoServiceProvider.Encrypt and RSACryptoServiceProvider.Decrypt methods that take a Boolean are obsolete. Use the overload that accepts RSAEncryptionPadding instead.

Analyzer Warnings

The diagnostic id values reserved for .NET Libraries analyzer warnings are SYSLIB1001 through SYSLIB1999. When creating a new analyzer that ships as part of the Libraries (and not part of the SDK), claim the next three-digit identifier in the SYSLIB1### sequence and add it to the list below.

Analyzer Diagnostics (SYSLIB1001 - SYSLIB1999)

Diagnostic IDDescription
SYSLIB1001Logging method names cannot start with _
SYSLIB1002Don't include log level parameters as templates in the logging message
SYSLIB1003InvalidLoggingMethodParameterNameTitle
SYSLIB1004Logging class cannot be in nested types
SYSLIB1005Could not find a required type definition
SYSLIB1006Multiple logging methods cannot use the same event id within a class
SYSLIB1007Logging methods must return void
SYSLIB1008One of the arguments to a logging method must implement the Microsoft.Extensions.Logging.ILogger interface
SYSLIB1009Logging methods must be static
SYSLIB1010Logging methods must be partial
SYSLIB1011Logging methods cannot use the allows ref struct constraint
SYSLIB1012Redundant qualifier in logging message
SYSLIB1013Don't include exception parameters as templates in the logging message
SYSLIB1014Logging template has no corresponding method argument
SYSLIB1015Argument is not referenced from the logging message
SYSLIB1016Logging methods cannot have a body
SYSLIB1017A LogLevel value must be supplied in the LoggerMessage attribute or as a parameter to the logging method
SYSLIB1018Don't include logger parameters as templates in the logging message
SYSLIB1019Couldn't find a field of type Microsoft.Extensions.Logging.ILogger
SYSLIB1020Found multiple fields of type Microsoft.Extensions.Logging.ILogger
SYSLIB1021Can't have the same template with different casing
SYSLIB1022Logging method contains malformed format strings
SYSLIB1023Generating more than 6 arguments is not supported
SYSLIB1024Argument is using the unsupported out parameter modifier
SYSLIB1025Multiple logging methods cannot use the same event name within a class
SYSLIB1026C# language version not supported by the logging source generator.
SYSLIB1027Primary constructor parameter of type Microsoft.Extensions.Logging.ILogger is hidden by a field
SYSLIB1028Argument is using the unsupported params parameter modifier
SYSLIB1029Logging method parameter is a ref struct
SYSLIB1030JsonSourceGenerator did not generate serialization metadata for type
SYSLIB1031JsonSourceGenerator encountered a duplicate JsonTypeInfo property name
SYSLIB1032JsonSourceGenerator encountered a context class that is not partial
SYSLIB1033JsonSourceGenerator encountered a type that has multiple [JsonConstructor] annotations
SYSLIB1034JsonSourceGenerator encountered a [JsonStringEnumConverter] annotation
SYSLIB1035JsonSourceGenerator encountered a type that has multiple [JsonExtensionData] annotations
SYSLIB1036JsonSourceGenerator encountered an invalid [JsonExtensionData] annotation
SYSLIB1037JsonSourceGenerator encountered a type with init-only properties for which deserialization is not supported
SYSLIB1038JsonSourceGenerator encountered a property annotated with [JsonInclude] that has inaccessible accessors
SYSLIB1039JsonSourceGenerator encountered a [JsonDerivedTypeAttribute] annotation with [JsonSourceGenerationMode.Serialization] enabled
SYSLIB1040Invalid GeneratedRegex attribute
SYSLIB1041Multiple GeneratedRegex attribute
SYSLIB1042Invalid GeneratedRegex arguments
SYSLIB1043GeneratedRegex method must have a valid signature
SYSLIB1044GeneratedRegex only supports C# 11 and newer
SYSLIB1045Use 'GeneratedRegexAttribute' to generate the regular expression implementation at compile-time
SYSLIB1046SYSLIB1045-SYSLIB1049 reserved for System.Text.RegularExpressions.Generator.
SYSLIB1047SYSLIB1045-SYSLIB1049 reserved for System.Text.RegularExpressions.Generator.
SYSLIB1048SYSLIB1045-SYSLIB1049 reserved for System.Text.RegularExpressions.Generator.
SYSLIB1049SYSLIB1045-SYSLIB1049 reserved for System.Text.RegularExpressions.Generator.
SYSLIB1050Invalid LibraryImportAttribute usage
SYSLIB1051Specified type is not supported by source-generated P/Invokes
SYSLIB1052Specified configuration is not supported by source-generated P/Invokes
SYSLIB1053Specified LibraryImportAttribute arguments cannot be forwarded to DllImportAttribute
SYSLIB1054Use 'LibraryImportAttribute' instead of 'DllImportAttribute' to generate P/Invoke marshalling code at compile time
SYSLIB1055Invalid CustomMarshallerAttribute usage
SYSLIB1056Specified native type is invalid
SYSLIB1057Marshaller type does not have the required shape
SYSLIB1058Invalid NativeMarshallingAttribute usage
SYSLIB1059Marshaller type does not support allocating constructor
SYSLIB1060Specified marshaller type is invalid
SYSLIB1061Marshaller type has incompatible method signatures
SYSLIB1062Project must be updated with '<AllowUnsafeBlocks>true</AllowUnsafeBlocks>'
SYSLIB1063SYSLIB1063-SYSLIB1069 reserved for Microsoft.Interop.LibraryImportGenerator.
SYSLIB1064SYSLIB1063-SYSLIB1069 reserved for Microsoft.Interop.LibraryImportGenerator.
SYSLIB1065SYSLIB1063-SYSLIB1069 reserved for Microsoft.Interop.LibraryImportGenerator.
SYSLIB1066SYSLIB1063-SYSLIB1069 reserved for Microsoft.Interop.LibraryImportGenerator.
SYSLIB1067SYSLIB1063-SYSLIB1069 reserved for Microsoft.Interop.LibraryImportGenerator.
SYSLIB1068SYSLIB1063-SYSLIB1069 reserved for Microsoft.Interop.LibraryImportGenerator.
SYSLIB1069SYSLIB1063-SYSLIB1069 reserved for Microsoft.Interop.LibraryImportGenerator.
SYSLIB1070Invalid 'JSImportAttribute' usage
SYSLIB1071Invalid 'JSExportAttribute' usage
SYSLIB1072Specified type is not supported by source-generated JavaScript interop
SYSLIB1073Specified configuration is not supported by source-generated JavaScript interop
SYSLIB1074JSImportAttribute requires unsafe code
SYSLIB1075JSExportAttribute requires unsafe code
SYSLIB1076SYSLIB1070-SYSLIB1089 reserved for System.Runtime.InteropServices.JavaScript.JSImportGenerator.
SYSLIB1077SYSLIB1070-SYSLIB1089 reserved for System.Runtime.InteropServices.JavaScript.JSImportGenerator.
SYSLIB1078SYSLIB1070-SYSLIB1089 reserved for System.Runtime.InteropServices.JavaScript.JSImportGenerator.
SYSLIB1079SYSLIB1070-SYSLIB1089 reserved for System.Runtime.InteropServices.JavaScript.JSImportGenerator.
SYSLIB1080SYSLIB1070-SYSLIB1089 reserved for System.Runtime.InteropServices.JavaScript.JSImportGenerator.
SYSLIB1081SYSLIB1070-SYSLIB1089 reserved for System.Runtime.InteropServices.JavaScript.JSImportGenerator.
SYSLIB1082SYSLIB1070-SYSLIB1089 reserved for System.Runtime.InteropServices.JavaScript.JSImportGenerator.
SYSLIB1083SYSLIB1070-SYSLIB1089 reserved for System.Runtime.InteropServices.JavaScript.JSImportGenerator.
SYSLIB1084SYSLIB1070-SYSLIB1089 reserved for System.Runtime.InteropServices.JavaScript.JSImportGenerator.
SYSLIB1085SYSLIB1070-SYSLIB1089 reserved for System.Runtime.InteropServices.JavaScript.JSImportGenerator.
SYSLIB1086SYSLIB1070-SYSLIB1089 reserved for System.Runtime.InteropServices.JavaScript.JSImportGenerator.
SYSLIB1087SYSLIB1070-SYSLIB1089 reserved for System.Runtime.InteropServices.JavaScript.JSImportGenerator.
SYSLIB1088SYSLIB1070-SYSLIB1089 reserved for System.Runtime.InteropServices.JavaScript.JSImportGenerator.
SYSLIB1089SYSLIB1070-SYSLIB1089 reserved for System.Runtime.InteropServices.JavaScript.JSImportGenerator.
SYSLIB1090Invalid 'GeneratedComInterfaceAttribute' usage
SYSLIB1091Method is declared in different partial declaration than the 'GeneratedComInterface' attribute.
SYSLIB1092Usage of '[LibraryImport
SYSLIB1093Analysis for COM interface generation has failed
SYSLIB1094The base COM interface failed to generate source. Code will not be generated for this interface.
SYSLIB1095Invalid 'GeneratedComClassAttribute' usage
SYSLIB1096Use 'GeneratedComInterfaceAttribute' instead of 'ComImportAttribute' to generate COM marshalling code at compile time
SYSLIB1097This type implements at least one type with the 'GeneratedComInterfaceAttribute' attribute. Add the 'GeneratedComClassAttribute' to enable passing this type to COM and exposing the COM interfaces for the types with the 'GeneratedComInterfaceAttribute' from objects of this type.
SYSLIB1098.NET COM hosting with 'EnableComHosting' only supports built-in COM interop. It does not support source-generated COM interop with 'GeneratedComInterfaceAttribute'.
SYSLIB1099COM Interop APIs on 'System.Runtime.InteropServices.Marshal' do not support source-generated COM and will fail at runtime
SYSLIB1100Configuration binding generator: type is not supported.
SYSLIB1101Configuration binding generator: property on type is not supported.
SYSLIB1102Configuration binding generator: project's language version must be at least C# 12.
SYSLIB1103Configuration binding generator: value types are invalid inputs to configuration 'Bind' methods.*
SYSLIB1104Configuration binding generator: Generator cannot determine the target configuration type.*
SYSLIB1105SYSLIB1100-SYSLIB1118 reserved for Microsoft.Extensions.Configuration.Binder.SourceGeneration.
SYSLIB1106SYSLIB1100-SYSLIB1118 reserved for Microsoft.Extensions.Configuration.Binder.SourceGeneration.
SYSLIB1107SYSLIB1100-SYSLIB1118 reserved for Microsoft.Extensions.Configuration.Binder.SourceGeneration.
SYSLIB1108SYSLIB1100-SYSLIB1118 reserved for Microsoft.Extensions.Configuration.Binder.SourceGeneration.
SYSLIB1109SYSLIB1100-SYSLIB1118 reserved for Microsoft.Extensions.Configuration.Binder.SourceGeneration.
SYSLIB1110SYSLIB1100-SYSLIB1118 reserved for Microsoft.Extensions.Configuration.Binder.SourceGeneration.
SYSLIB1111SYSLIB1100-SYSLIB1118 reserved for Microsoft.Extensions.Configuration.Binder.SourceGeneration.
SYSLIB1112SYSLIB1100-SYSLIB1118 reserved for Microsoft.Extensions.Configuration.Binder.SourceGeneration.
SYSLIB1113SYSLIB1100-SYSLIB1118 reserved for Microsoft.Extensions.Configuration.Binder.SourceGeneration.
SYSLIB1114SYSLIB1100-SYSLIB1118 reserved for Microsoft.Extensions.Configuration.Binder.SourceGeneration.
SYSLIB1115SYSLIB1100-SYSLIB1118 reserved for Microsoft.Extensions.Configuration.Binder.SourceGeneration.
SYSLIB1116SYSLIB1100-SYSLIB1118 reserved for Microsoft.Extensions.Configuration.Binder.SourceGeneration.
SYSLIB1117SYSLIB1100-SYSLIB1118 reserved for Microsoft.Extensions.Configuration.Binder.SourceGeneration.
SYSLIB1118SYSLIB1100-SYSLIB1118 reserved for Microsoft.Extensions.Configuration.Binder.SourceGeneration.
SYSLIB1201Options validation generator: Can't use 'ValidateObjectMembersAttribute' or ValidateEnumeratedItemsAttribute on fields or properties with open generic types.
SYSLIB1202Options validation generator: A member type has no fields or properties to validate.
SYSLIB1203Options validation generator: A type has no fields or properties to validate.
SYSLIB1204Options validation generator: A type annotated with OptionsValidatorAttribute doesn't implement the necessary interface.
SYSLIB1205Options validation generator: A type already includes an implementation of the 'Validate' method.
SYSLIB1206Options validation generator: Can't validate private fields or properties.
SYSLIB1207Options validation generator: Member type is not enumerable.
SYSLIB1208Options validation generator: Validators used for transitive or enumerable validation must have a constructor with no parameters.
SYSLIB1209Options validation generator: OptionsValidatorAttribute can't be applied to a static class.
SYSLIB1210Options validation generator: Null validator type specified for the ValidateObjectMembersAttribute or 'ValidateEnumeratedItemsAttribute' attributes.
SYSLIB1211Options validation generator: Unsupported circular references in model types.
SYSLIB1212Options validation generator: Member potentially missing transitive validation.
SYSLIB1213Options validation generator: Member potentially missing enumerable validation.
SYSLIB1214Options validation generator: Can't validate constants, static fields or properties.
SYSLIB1215Options validation generator: Validation attribute on the member is inaccessible from the validator type.
SYSLIB1216C# language version not supported by the options validation source generator.
SYSLIB1217The validation attribute is only applicable to properties of type string, array, or ICollection; it cannot be used with other types.
SYSLIB1218SYSLIB1201-SYSLIB1219 reserved for Microsoft.Extensions.Options.SourceGeneration.
SYSLIB1219SYSLIB1201-SYSLIB1219 reserved for Microsoft.Extensions.Options.SourceGeneration.
SYSLIB1220JsonSourceGenerator encountered a [JsonConverterAttribute] with an invalid type argument.
SYSLIB1221JsonSourceGenerator does not support this C# language version.
SYSLIB1222Constructor annotated with JsonConstructorAttribute is inaccessible.
SYSLIB1223Attributes deriving from JsonConverterAttribute are not supported by the source generator.
SYSLIB1224Types annotated with JsonSerializableAttribute must be classes deriving from JsonSerializerContext.
SYSLIB1225Type includes ref like property, field or constructor parameter.
SYSLIB1226SYSLIB1220-SYSLIB1229 reserved for System.Text.Json.SourceGeneration.
SYSLIB1227SYSLIB1220-SYSLIB1229 reserved for System.Text.Json.SourceGeneration.
SYSLIB1228SYSLIB1220-SYSLIB1229 reserved for System.Text.Json.SourceGeneration.
SYSLIB1229SYSLIB1220-SYSLIB1229 reserved for System.Text.Json.SourceGeneration.
SYSLIB1230Deriving from a GeneratedComInterface-attributed interface defined in another assembly is not supported.
SYSLIB1231SYSLIB1230-SYSLIB1239 reserved for Microsoft.Interop.ComInterfaceGenerator.
SYSLIB1232SYSLIB1230-SYSLIB1239 reserved for Microsoft.Interop.ComInterfaceGenerator.
SYSLIB1233SYSLIB1230-SYSLIB1239 reserved for Microsoft.Interop.ComInterfaceGenerator.
SYSLIB1234SYSLIB1230-SYSLIB1239 reserved for Microsoft.Interop.ComInterfaceGenerator.
SYSLIB1235SYSLIB1230-SYSLIB1239 reserved for Microsoft.Interop.ComInterfaceGenerator.
SYSLIB1236SYSLIB1230-SYSLIB1239 reserved for Microsoft.Interop.ComInterfaceGenerator.
SYSLIB1237SYSLIB1230-SYSLIB1239 reserved for Microsoft.Interop.ComInterfaceGenerator.
SYSLIB1238SYSLIB1230-SYSLIB1239 reserved for Microsoft.Interop.ComInterfaceGenerator.
SYSLIB1239SYSLIB1230-SYSLIB1239 reserved for Microsoft.Interop.ComInterfaceGenerator.

Diagnostic Suppressions (SYSLIBSUPPRESS****)

Suppression IDSuppressed Diagnostic IDDescription
SYSLIBSUPPRESS0001CA1822Do not offer to make methods static when the methods need to be instance methods for a custom marshaller shape.
SYSLIBSUPPRESS0002IL2026ConfigurationBindingGenerator: suppress RequiresUnreferencedCode diagnostic for binding call that has been intercepted by a generated static variant.
SYSLIBSUPPRESS0003IL3050ConfigurationBindingGenerator: suppress RequiresDynamicCode diagnostic for binding call that has been intercepted by a generated static variant.

Experimental APIs

APIs can be marked as [Experimental] if their shape or functionality is included in a release but not yet officially supported. Experimental APIs offer the opportunity to collect customer feedback on these APIs in a major release, usually refining the APIs and removing the [Experimental] attribute in the next release. The [Experimental] attribute differs from [RequiresPreviewFeatures], wherein:

  • [RequiresPreviewFeatures] APIs require a corresponding preview feature in another product area such as the compiler or SDK
    • Using these APIs requires enabling preview features for the project and all its consumers
  • [Experimental] APIs are self-contained within the libraries and do not require preview features in other parts of the product
    • These APIs can be used by suppressing specific diagnostics without enabling preview features for the project

See Preview APIs - .NET | Microsoft Learn for more information.

Experimental Diagnostics (SYSLIB5001 - SYSLIB5999)

The diagnostic id values reserved for experimental APIs are SYSLIB5001 through SYSLIB5999. When marking an API as [Experimental], claim the next three-digit identifier in the SYSLIB5### sequence and add it to the list below. The URL template for all experimental APIs is https://aka.ms/dotnet-warnings/{0}. The {0} placeholder is replaced by the compiler with the SYSLIB5### identifier.

Diagnostic id values for experimental APIs must not be recycled, as that could silently opt customers into new experimental APIs where they had previously suppressed the ID for a previous usage of the value.

Diagnostic IDIntroducedRemovedDescription
SYSLIB5001.NET 9.NET 10Tensor<T> and related APIs in System.Numerics.Tensors are experimental
SYSLIB5002.NET 9TBDSystemColors alternate colors are experimental
SYSLIB5003.NET 9TBDSystem.Runtime.Intrinsics.Arm.Sve is experimental
SYSLIB5004.NET 9TBDX86Base.DivRem is experimental since performance is not as optimized as T.DivRem
SYSLIB5005.NET 9.NET 10System.Formats.Nrbf is experimental
SYSLIB5006.NET 10TBDTypes for Post-Quantum Cryptography (PQC) are experimental.