| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>Microsoft.Extensions.Logging.Console</name>
- </assembly>
- <members>
- <member name="T:Microsoft.Extensions.Logging.Console.AnsiLogConsole">
- <summary>
- For consoles which understand the ANSI escape code sequences to represent color
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.Logging.Console.AnsiParser.Parse(System.String)">
- <summary>
- Parses a subset of display attributes
- Set Display Attributes
- Set Attribute Mode [{attr1};...;{attrn}m
- Sets multiple display attribute settings. The following lists standard attributes that are getting parsed:
- 1 Bright
- Foreground Colours
- 30 Black
- 31 Red
- 32 Green
- 33 Yellow
- 34 Blue
- 35 Magenta
- 36 Cyan
- 37 White
- Background Colours
- 40 Black
- 41 Red
- 42 Green
- 43 Yellow
- 44 Blue
- 45 Magenta
- 46 Cyan
- 47 White
- </summary>
- </member>
- <member name="T:Microsoft.Extensions.Logging.Console.ConsoleFormatter">
- <summary>
- Allows custom log messages formatting
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Logging.Console.ConsoleFormatter.Name">
- <summary>
- Gets the name associated with the console log formatter.
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.Logging.Console.ConsoleFormatter.Write``1(Microsoft.Extensions.Logging.Abstractions.LogEntry{``0}@,Microsoft.Extensions.Logging.IExternalScopeProvider,System.IO.TextWriter)">
- <summary>
- Writes the log message to the specified TextWriter.
- </summary>
- <remarks>
- if the formatter wants to write colors to the console, it can do so by embedding ANSI color codes into the string
- </remarks>
- <param name="logEntry">The log entry.</param>
- <param name="scopeProvider">The provider of scope data.</param>
- <param name="textWriter">The string writer embedding ansi code for colors.</param>
- <typeparam name="TState">The type of the object to be written.</typeparam>
- </member>
- <member name="T:Microsoft.Extensions.Logging.Console.ConsoleFormatterNames">
- <summary>
- Reserved formatter names for the built-in console formatters.
- </summary>
- </member>
- <member name="F:Microsoft.Extensions.Logging.Console.ConsoleFormatterNames.Simple">
- <summary>
- Reserved name for simple console formatter
- </summary>
- </member>
- <member name="F:Microsoft.Extensions.Logging.Console.ConsoleFormatterNames.Json">
- <summary>
- Reserved name for json console formatter
- </summary>
- </member>
- <member name="F:Microsoft.Extensions.Logging.Console.ConsoleFormatterNames.Systemd">
- <summary>
- Reserved name for systemd console formatter
- </summary>
- </member>
- <member name="T:Microsoft.Extensions.Logging.Console.ConsoleFormatterOptions">
- <summary>
- Options for the built-in console log formatter.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Logging.Console.ConsoleFormatterOptions.IncludeScopes">
- <summary>
- Includes scopes when <see langword="true" />.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Logging.Console.ConsoleFormatterOptions.TimestampFormat">
- <summary>
- Gets or sets format string used to format timestamp in logging messages. Defaults to <c>null</c>.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Logging.Console.ConsoleFormatterOptions.UseUtcTimestamp">
- <summary>
- Gets or sets indication whether or not UTC timezone should be used to for timestamps in logging messages. Defaults to <c>false</c>.
- </summary>
- </member>
- <member name="T:Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat">
- <summary>
- Format of <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger" /> messages.
- </summary>
- </member>
- <member name="F:Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat.Default">
- <summary>
- Produces messages in the default console format.
- </summary>
- </member>
- <member name="F:Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat.Systemd">
- <summary>
- Produces messages in a format suitable for console output to the systemd journal.
- </summary>
- </member>
- <member name="T:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions">
- <summary>
- Options for a <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/>.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.DisableColors">
- <summary>
- Disables colors when <see langword="true" />.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.Format">
- <summary>
- Gets or sets log message format. Defaults to <see cref="F:Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat.Default" />.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.FormatterName">
- <summary>
- Name of the log message formatter to use. Defaults to "simple" />.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.IncludeScopes">
- <summary>
- Includes scopes when <see langword="true" />.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.LogToStandardErrorThreshold">
- <summary>
- Gets or sets value indicating the minimum level of messages that would get written to <c>Console.Error</c>.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.TimestampFormat">
- <summary>
- Gets or sets format string used to format timestamp in logging messages. Defaults to <c>null</c>.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.UseUtcTimestamp">
- <summary>
- Gets or sets indication whether or not UTC timezone should be used to for timestamps in logging messages. Defaults to <c>false</c>.
- </summary>
- </member>
- <member name="T:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider">
- <summary>
- A provider of <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> instances.
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider.#ctor(Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions})">
- <summary>
- Creates an instance of <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider"/>.
- </summary>
- <param name="options">The options to create <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> instances with.</param>
- </member>
- <member name="M:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider.#ctor(Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions},System.Collections.Generic.IEnumerable{Microsoft.Extensions.Logging.Console.ConsoleFormatter})">
- <summary>
- Creates an instance of <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider"/>.
- </summary>
- <param name="options">The options to create <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> instances with.</param>
- <param name="formatters">Log formatters added for <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> insteaces.</param>
- </member>
- <member name="M:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider.CreateLogger(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider.Dispose">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider.SetScopeProvider(Microsoft.Extensions.Logging.IExternalScopeProvider)">
- <inheritdoc />
- </member>
- <member name="T:Microsoft.Extensions.Logging.Console.JsonConsoleFormatterOptions">
- <summary>
- Options for the built-in json console log formatter.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Logging.Console.JsonConsoleFormatterOptions.JsonWriterOptions">
- <summary>
- Gets or sets JsonWriterOptions.
- </summary>
- </member>
- <member name="T:Microsoft.Extensions.Logging.Console.LoggerColorBehavior">
- <summary>
- Determines when to use color when logging messages.
- </summary>
- </member>
- <member name="F:Microsoft.Extensions.Logging.Console.LoggerColorBehavior.Default">
- <summary>
- Use the default color behavior, enabling color except when the console output is redirected.
- </summary>
- <remarks>
- Enables color except when the console output is redirected.
- </remarks>
- </member>
- <member name="F:Microsoft.Extensions.Logging.Console.LoggerColorBehavior.Enabled">
- <summary>
- Enable color for logging
- </summary>
- </member>
- <member name="F:Microsoft.Extensions.Logging.Console.LoggerColorBehavior.Disabled">
- <summary>
- Disable color for logging
- </summary>
- </member>
- <member name="T:Microsoft.Extensions.Logging.Console.SimpleConsoleFormatterOptions">
- <summary>
- Options for the built-in default console log formatter.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Logging.Console.SimpleConsoleFormatterOptions.ColorBehavior">
- <summary>
- Determines when to use color when logging messages.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Logging.Console.SimpleConsoleFormatterOptions.SingleLine">
- <summary>
- When <see langword="true" />, the entire message gets logged in a single line.
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsole(Microsoft.Extensions.Logging.ILoggingBuilder)">
- <summary>
- Adds a console logger named 'Console' to the factory.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
- </member>
- <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsole(Microsoft.Extensions.Logging.ILoggingBuilder,System.Action{Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions})">
- <summary>
- Adds a console logger named 'Console' to the factory.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
- <param name="configure">A delegate to configure the <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/>.</param>
- </member>
- <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddSimpleConsole(Microsoft.Extensions.Logging.ILoggingBuilder)">
- <summary>
- Add the default console log formatter named 'simple' to the factory with default properties.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
- </member>
- <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddSimpleConsole(Microsoft.Extensions.Logging.ILoggingBuilder,System.Action{Microsoft.Extensions.Logging.Console.SimpleConsoleFormatterOptions})">
- <summary>
- Add and configure a console log formatter named 'simple' to the factory.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
- <param name="configure">A delegate to configure the <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> options for the built-in default log formatter.</param>
- </member>
- <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddJsonConsole(Microsoft.Extensions.Logging.ILoggingBuilder)">
- <summary>
- Add a console log formatter named 'json' to the factory with default properties.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
- </member>
- <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddJsonConsole(Microsoft.Extensions.Logging.ILoggingBuilder,System.Action{Microsoft.Extensions.Logging.Console.JsonConsoleFormatterOptions})">
- <summary>
- Add and configure a console log formatter named 'json' to the factory.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
- <param name="configure">A delegate to configure the <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> options for the built-in json log formatter.</param>
- </member>
- <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddSystemdConsole(Microsoft.Extensions.Logging.ILoggingBuilder,System.Action{Microsoft.Extensions.Logging.Console.ConsoleFormatterOptions})">
- <summary>
- Add and configure a console log formatter named 'systemd' to the factory.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
- <param name="configure">A delegate to configure the <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> options for the built-in systemd log formatter.</param>
- </member>
- <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddSystemdConsole(Microsoft.Extensions.Logging.ILoggingBuilder)">
- <summary>
- Add a console log formatter named 'systemd' to the factory with default properties.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
- </member>
- <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsoleFormatter``2(Microsoft.Extensions.Logging.ILoggingBuilder)">
- <summary>
- Adds a custom console logger formatter 'TFormatter' to be configured with options 'TOptions'.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
- </member>
- <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsoleFormatter``2(Microsoft.Extensions.Logging.ILoggingBuilder,System.Action{``1})">
- <summary>
- Adds a custom console logger formatter 'TFormatter' to be configured with options 'TOptions'.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
- <param name="configure">A delegate to configure options 'TOptions' for custom formatter 'TFormatter'.</param>
- </member>
- <member name="T:Microsoft.Extensions.Logging.NullExternalScopeProvider">
- <summary>
- Scope provider that does nothing.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Logging.NullExternalScopeProvider.Instance">
- <summary>
- Returns a cached instance of <see cref="T:Microsoft.Extensions.Logging.NullExternalScopeProvider"/>.
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.Logging.NullExternalScopeProvider.Microsoft#Extensions#Logging#IExternalScopeProvider#ForEachScope``1(System.Action{System.Object,``0},``0)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.Extensions.Logging.NullExternalScopeProvider.Microsoft#Extensions#Logging#IExternalScopeProvider#Push(System.Object)">
- <inheritdoc />
- </member>
- <member name="T:Microsoft.Extensions.Logging.NullScope">
- <summary>
- An empty scope without any logic
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.Logging.NullScope.Dispose">
- <inheritdoc />
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute">
- <summary>
- Indicates that certain members on a specified <see cref="T:System.Type"/> are accessed dynamically,
- for example through <see cref="N:System.Reflection"/>.
- </summary>
- <remarks>
- This allows tools to understand which members are being accessed during the execution
- of a program.
-
- This attribute is valid on members whose type is <see cref="T:System.Type"/> or <see cref="T:System.String"/>.
-
- When this attribute is applied to a location of type <see cref="T:System.String"/>, the assumption is
- that the string represents a fully qualified type name.
-
- When this attribute is applied to a class, interface, or struct, the members specified
- can be accessed dynamically on <see cref="T:System.Type"/> instances returned from calling
- <see cref="M:System.Object.GetType"/> on instances of that class, interface, or struct.
-
- If the attribute is applied to a method it's treated as a special case and it implies
- the attribute should be applied to the "this" parameter of the method. As such the attribute
- should only be used on instance methods of types assignable to System.Type (or string, but no methods
- will use it there).
- </remarks>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes)">
- <summary>
- Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute"/> class
- with the specified member types.
- </summary>
- <param name="memberTypes">The types of members dynamically accessed.</param>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.MemberTypes">
- <summary>
- Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
- of members dynamically accessed.
- </summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes">
- <summary>
- Specifies the types of members that are dynamically accessed.
-
- This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a
- bitwise combination of its member values.
- </summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None">
- <summary>
- Specifies no members.
- </summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor">
- <summary>
- Specifies the default, parameterless public constructor.
- </summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors">
- <summary>
- Specifies all public constructors.
- </summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors">
- <summary>
- Specifies all non-public constructors.
- </summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods">
- <summary>
- Specifies all public methods.
- </summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods">
- <summary>
- Specifies all non-public methods.
- </summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields">
- <summary>
- Specifies all public fields.
- </summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields">
- <summary>
- Specifies all non-public fields.
- </summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes">
- <summary>
- Specifies all public nested types.
- </summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes">
- <summary>
- Specifies all non-public nested types.
- </summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties">
- <summary>
- Specifies all public properties.
- </summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties">
- <summary>
- Specifies all non-public properties.
- </summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents">
- <summary>
- Specifies all public events.
- </summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents">
- <summary>
- Specifies all non-public events.
- </summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces">
- <summary>
- Specifies all interfaces implemented by the type.
- </summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All">
- <summary>
- Specifies all members.
- </summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute">
- <summary>
- Indicates that the specified method requires dynamic access to code that is not referenced
- statically, for example through <see cref="N:System.Reflection"/>.
- </summary>
- <remarks>
- This allows tools to understand which methods are unsafe to call when removing unreferenced
- code from an application.
- </remarks>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute"/> class
- with the specified message.
- </summary>
- <param name="message">
- A message that contains information about the usage of unreferenced code.
- </param>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Message">
- <summary>
- Gets a message that contains information about the usage of unreferenced code.
- </summary>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Url">
- <summary>
- Gets or sets an optional URL that contains more information about the method,
- why it requries unreferenced code, and what options a consumer has to deal with it.
- </summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute">
- <summary>
- Suppresses reporting of a specific rule violation, allowing multiple suppressions on a
- single code artifact.
- </summary>
- <remarks>
- <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> is different than
- <see cref="T:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute"/> in that it doesn't have a
- <see cref="T:System.Diagnostics.ConditionalAttribute"/>. So it is always preserved in the compiled assembly.
- </remarks>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/>
- class, specifying the category of the tool and the identifier for an analysis rule.
- </summary>
- <param name="category">The category for the attribute.</param>
- <param name="checkId">The identifier of the analysis rule the attribute applies to.</param>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category">
- <summary>
- Gets the category identifying the classification of the attribute.
- </summary>
- <remarks>
- The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> property describes the tool or tool analysis category
- for which a message suppression attribute applies.
- </remarks>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId">
- <summary>
- Gets the identifier of the analysis tool rule to be suppressed.
- </summary>
- <remarks>
- Concatenated together, the <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> and <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId"/>
- properties form a unique check identifier.
- </remarks>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Scope">
- <summary>
- Gets or sets the scope of the code that is relevant for the attribute.
- </summary>
- <remarks>
- The Scope property is an optional argument that specifies the metadata scope for which
- the attribute is relevant.
- </remarks>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target">
- <summary>
- Gets or sets a fully qualified path that represents the target of the attribute.
- </summary>
- <remarks>
- The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target"/> property is an optional argument identifying the analysis target
- of the attribute. An example value is "System.IO.Stream.ctor():System.Void".
- Because it is fully qualified, it can be long, particularly for targets such as parameters.
- The analysis tool user interface should be capable of automatically formatting the parameter.
- </remarks>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId">
- <summary>
- Gets or sets an optional argument expanding on exclusion criteria.
- </summary>
- <remarks>
- The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId"/> property is an optional argument that specifies additional
- exclusion where the literal metadata target is not sufficiently precise. For example,
- the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> cannot be applied within a method,
- and it may be desirable to suppress a violation against a statement in the method that will
- give a rule violation, but not against all statements in the method.
- </remarks>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Justification">
- <summary>
- Gets or sets the justification for suppressing the code analysis message.
- </summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
- <summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
- <summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
- <summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
- <summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
- <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
- <summary>Initializes the attribute with the specified return value condition.</summary>
- <param name="returnValue">
- The return value condition. If the method returns this value, the associated parameter may be null.
- </param>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
- <summary>Gets the return value condition.</summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
- <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
- <summary>Initializes the attribute with the specified return value condition.</summary>
- <param name="returnValue">
- The return value condition. If the method returns this value, the associated parameter will not be null.
- </param>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
- <summary>Gets the return value condition.</summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
- <summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
- <summary>Initializes the attribute with the associated parameter name.</summary>
- <param name="parameterName">
- The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
- </param>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
- <summary>Gets the associated parameter name.</summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
- <summary>Applied to a method that will never return under any circumstance.</summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
- <summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
- <summary>Initializes the attribute with the specified parameter value.</summary>
- <param name="parameterValue">
- The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
- the associated parameter matches this value.
- </param>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
- <summary>Gets the condition parameter value.</summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
- <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
- <summary>Initializes the attribute with a field or property member.</summary>
- <param name="member">
- The field or property member that is promised to be not-null.
- </param>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
- <summary>Initializes the attribute with the list of field and property members.</summary>
- <param name="members">
- The list of field and property members that are promised to be not-null.
- </param>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
- <summary>Gets field or property member names.</summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
- <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
- <summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
- <param name="returnValue">
- The return value condition. If the method returns this value, the associated parameter will not be null.
- </param>
- <param name="member">
- The field or property member that is promised to be not-null.
- </param>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
- <summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
- <param name="returnValue">
- The return value condition. If the method returns this value, the associated parameter will not be null.
- </param>
- <param name="members">
- The list of field and property members that are promised to be not-null.
- </param>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
- <summary>Gets the return value condition.</summary>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
- <summary>Gets field or property member names.</summary>
- </member>
- <member name="P:System.SR.BufferMaximumSizeExceeded">
- <summary>Cannot allocate a buffer of size {0}.</summary>
- </member>
- <member name="T:System.Runtime.Versioning.OSPlatformAttribute">
- <summary>
- Base type for all platform-specific API attributes.
- </summary>
- </member>
- <member name="T:System.Runtime.Versioning.TargetPlatformAttribute">
- <summary>
- Records the platform that the project targeted.
- </summary>
- </member>
- <member name="T:System.Runtime.Versioning.SupportedOSPlatformAttribute">
- <summary>
- Records the operating system (and minimum version) that supports an API. Multiple attributes can be
- applied to indicate support on multiple operating systems.
- </summary>
- <remarks>
- Callers can apply a <see cref="T:System.Runtime.Versioning.SupportedOSPlatformAttribute" />
- or use guards to prevent calls to APIs on unsupported operating systems.
-
- A given platform should only be specified once.
- </remarks>
- </member>
- <member name="T:System.Runtime.Versioning.UnsupportedOSPlatformAttribute">
- <summary>
- Marks APIs that were removed in a given operating system version.
- </summary>
- <remarks>
- Primarily used by OS bindings to indicate APIs that are only available in
- earlier versions.
- </remarks>
- </member>
- <member name="T:System.Runtime.Versioning.SupportedOSPlatformGuardAttribute">
- <summary>
- Annotates a custom guard field, property or method with a supported platform name and optional version.
- Multiple attributes can be applied to indicate guard for multiple supported platforms.
- </summary>
- <remarks>
- Callers can apply a <see cref="T:System.Runtime.Versioning.SupportedOSPlatformGuardAttribute" /> to a field, property or method
- and use that field, property or method in a conditional or assert statements in order to safely call platform specific APIs.
-
- The type of the field or property should be boolean, the method return type should be boolean in order to be used as platform guard.
- </remarks>
- </member>
- <member name="T:System.Runtime.Versioning.UnsupportedOSPlatformGuardAttribute">
- <summary>
- Annotates the custom guard field, property or method with an unsupported platform name and optional version.
- Multiple attributes can be applied to indicate guard for multiple unsupported platforms.
- </summary>
- <remarks>
- Callers can apply a <see cref="T:System.Runtime.Versioning.UnsupportedOSPlatformGuardAttribute" /> to a field, property or method
- and use that field, property or method in a conditional or assert statements as a guard to safely call APIs unsupported on those platforms.
-
- The type of the field or property should be boolean, the method return type should be boolean in order to be used as platform guard.
- </remarks>
- </member>
- </members>
- </doc>
|