<?xml version="1.0"?>
|
<doc>
|
<assembly>
|
<name>Microsoft.Extensions.Logging.EventSource</name>
|
</assembly>
|
<members>
|
<member name="T:Microsoft.Extensions.Logging.EventSource.EventSourceLogger">
|
<summary>
|
A logger that writes messages to EventSource instance.
|
</summary>
|
<remarks>
|
On Windows platforms EventSource will deliver messages using Event Tracing for Windows (ETW) events.
|
On Linux EventSource will use LTTng (http://lttng.org) to deliver messages.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Extensions.Logging.EventSource.EventSourceLogger.Log``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})">
|
<inheritdoc />
|
</member>
|
<member name="T:Microsoft.Extensions.Logging.EventSource.EventSourceLogger.ActivityScope">
|
<summary>
|
ActivityScope is just a IDisposable that knows how to send the ActivityStop event when it is
|
desposed. It is part of the BeginScope() support.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Extensions.Logging.EventSource.EventSourceLogger.GetExceptionInfo(System.Exception)">
|
<summary>
|
'serializes' a given exception into an ExceptionInfo (that EventSource knows how to serialize)
|
</summary>
|
<param name="exception">The exception to get information for.</param>
|
<returns>ExceptionInfo object represending a .NET Exception</returns>
|
<remarks>ETW does not support a concept of a null value. So we use an un-initialized object if there is no exception in the event data.</remarks>
|
</member>
|
<member name="M:Microsoft.Extensions.Logging.EventSource.EventSourceLogger.GetProperties(System.Object)">
|
<summary>
|
Converts an ILogger state object into a set of key-value pairs (That can be send to a EventSource)
|
</summary>
|
</member>
|
<member name="T:Microsoft.Extensions.Logging.EventSource.EventSourceLoggerProvider">
|
<summary>
|
The provider for the <see cref="T:Microsoft.Extensions.Logging.EventSource.EventSourceLogger"/>.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Extensions.Logging.EventSource.EventSourceLoggerProvider.#ctor(Microsoft.Extensions.Logging.EventSource.LoggingEventSource)">
|
<summary>
|
Creates an instance of <see cref="T:Microsoft.Extensions.Logging.EventSource.EventSourceLoggerProvider"/>.
|
</summary>
|
<param name="eventSource">The logging event source.</param>
|
</member>
|
<member name="M:Microsoft.Extensions.Logging.EventSource.EventSourceLoggerProvider.CreateLogger(System.String)">
|
<inheritdoc />
|
</member>
|
<member name="M:Microsoft.Extensions.Logging.EventSource.EventSourceLoggerProvider.Dispose">
|
<inheritdoc />
|
</member>
|
<member name="T:Microsoft.Extensions.Logging.EventSource.ExceptionInfo">
|
<summary>
|
Represents information about exceptions that is captured by EventSourceLogger
|
</summary>
|
</member>
|
<member name="T:Microsoft.Extensions.Logging.EventSource.LoggingEventSource">
|
<summary>
|
The LoggingEventSource is the bridge from all ILogger based logging to EventSource/EventListener logging.
|
|
You turn this logging on by enabling the EventSource called
|
|
Microsoft-Extensions-Logging
|
|
When you enabled the EventSource, the EventLevel you set is translated in the obvious way to the level
|
associated with the ILogger (thus Debug = verbose, Informational = Informational ... Critical == Critical)
|
|
This allows you to filter by event level in a straightforward way.
|
|
For finer control you can specify a EventSource Argument called
|
|
FilterSpecs
|
|
The FilterSpecs argument is a semicolon separated list of specifications. Where each specification is
|
|
SPEC = // empty spec, same as *
|
| NAME // Just a name the level is the default level
|
| NAME : LEVEL // specifies level for a particular logger (can have a * suffix).
|
|
When "UseAppFilters" is specified in the FilterSpecs, it avoids disabling all categories which happens by default otherwise.
|
|
Where Name is the name of a ILoggger (case matters), Name can have a * which acts as a wildcard
|
AS A SUFFIX. Thus Net* will match any loggers that start with the 'Net'.
|
|
The LEVEL is a number or a LogLevel string. 0=Trace, 1=Debug, 2=Information, 3=Warning, 4=Error, Critical=5
|
This specifies the level for the associated pattern. If the number is not specified, (first form
|
of the specification) it is the default level for the EventSource.
|
|
First match is used if a particular name matches more than one pattern.
|
|
In addition the level and FilterSpec argument, you can also set EventSource Keywords. See the Keywords
|
definition below, but basically you get to decide if you wish to have
|
|
* Keywords.Message - You get the event with the data in parsed form.
|
* Keywords.JsonMessage - you get an event with the data in parse form but as a JSON blob (not broken up by argument ...)
|
* Keywords.FormattedMessage - you get an event with the data formatted as a string
|
|
It is expected that you will turn only one of these keywords on at a time, but you can turn them all on (and get
|
the same data logged three different ways.
|
|
Example Usage
|
|
This example shows how to use an EventListener to get ILogging information
|
|
class MyEventListener : EventListener {
|
protected override void OnEventSourceCreated(EventSource eventSource) {
|
if (eventSource.Name == "Microsoft-Extensions-Logging") {
|
// initialize a string, string dictionary of arguments to pass to the EventSource.
|
// Turn on loggers matching App* to Information, everything else (*) is the default level (which is EventLevel.Error)
|
var args = new Dictionary<string, string>() { { "FilterSpecs", "App*:Information;*" } };
|
// Set the default level (verbosity) to Error, and only ask for the formatted messages in this case.
|
EnableEvents(eventSource, EventLevel.Error, LoggingEventSource.Keywords.FormattedMessage, args);
|
}
|
}
|
protected override void OnEventWritten(EventWrittenEventArgs eventData) {
|
// Look for the formatted message event, which has the following argument layout (as defined in the LoggingEventSource.
|
// FormattedMessage(LogLevel Level, int FactoryID, string LoggerName, string EventId, string FormattedMessage);
|
if (eventData.EventName == "FormattedMessage")
|
Console.WriteLine("Logger {0}: {1}", eventData.Payload[2], eventData.Payload[4]);
|
}
|
}
|
</summary>
|
</member>
|
<member name="T:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords">
|
<summary>
|
This is public from an EventSource consumer point of view, but since these definitions
|
are not needed outside this class
|
</summary>
|
</member>
|
<member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords.Meta">
|
<summary>
|
Meta events are events about the LoggingEventSource itself (that is they did not come from ILogger
|
</summary>
|
</member>
|
<member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords.Message">
|
<summary>
|
Turns on the 'Message' event when ILogger.Log() is called. It gives the information in a programmatic (not formatted) way
|
</summary>
|
</member>
|
<member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords.FormattedMessage">
|
<summary>
|
Turns on the 'FormatMessage' event when ILogger.Log() is called. It gives the formatted string version of the information.
|
</summary>
|
</member>
|
<member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords.JsonMessage">
|
<summary>
|
Turns on the 'MessageJson' event when ILogger.Log() is called. It gives JSON representation of the Arguments.
|
</summary>
|
</member>
|
<member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Instance">
|
<summary>
|
The one and only instance of the LoggingEventSource.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.FormattedMessage(Microsoft.Extensions.Logging.LogLevel,System.Int32,System.String,System.Int32,System.String,System.String)">
|
<summary>
|
FormattedMessage() is called when ILogger.Log() is called. and the FormattedMessage keyword is active
|
This only gives you the human readable formatted message.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Message(Microsoft.Extensions.Logging.LogLevel,System.Int32,System.String,System.Int32,System.String,Microsoft.Extensions.Logging.EventSource.ExceptionInfo,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}})">
|
<summary>
|
Message() is called when ILogger.Log() is called. and the Message keyword is active
|
This gives you the logged information in a programmatic format (arguments are key-value pairs)
|
</summary>
|
</member>
|
<member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.ActivityStart(System.Int32,System.Int32,System.String,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}})">
|
<summary>
|
ActivityStart is called when ILogger.BeginScope() is called
|
</summary>
|
</member>
|
<member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.OnEventCommand(System.Diagnostics.Tracing.EventCommandEventArgs)">
|
<inheritdoc />
|
</member>
|
<member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.SetFilterSpec(System.String)">
|
<summary>
|
Set the filtering specification. null means turn off all loggers. Empty string is turn on all providers.
|
</summary>
|
<param name="filterSpec">The filter specification to set.</param>
|
</member>
|
<member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.ParseFilterSpec(System.String,Microsoft.Extensions.Logging.LogLevel)">
|
<summary>
|
Given a set of specifications Pat1:Level1;Pat1;Level2 ... Where
|
Pat is a string pattern (a logger Name with a optional trailing wildcard * char)
|
and Level is a number 0 (Trace) through 5 (Critical).
|
|
The :Level can be omitted (thus Pat1;Pat2 ...) in which case the level is 1 (Debug).
|
|
A completely empty string act like * (all loggers set to Debug level).
|
|
The first specification that 'loggers' Name matches is used.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.TryParseLevel(Microsoft.Extensions.Logging.LogLevel,System.String,Microsoft.Extensions.Logging.LogLevel@)">
|
<summary>
|
Parses the level specification (which should look like :N where n is a number 0 (Trace)
|
through 5 (Critical). It can also be an empty string (which means 1 (Debug) and ';' marks
|
the end of the specification. This specification should start at spec[curPos]
|
It returns the value in 'ret' and returns true if successful. If false is returned ret is left unchanged.
|
</summary>
|
</member>
|
<member name="T:Microsoft.Extensions.Logging.EventSourceLoggerFactoryExtensions">
|
<summary>
|
Extension methods for the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> class.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Extensions.Logging.EventSourceLoggerFactoryExtensions.AddEventSourceLogger(Microsoft.Extensions.Logging.ILoggerFactory)">
|
<summary>
|
Adds an logger that writes messages to the <see cref="T:Microsoft.Extensions.Logging.EventSource.LoggingEventSource"/> instance.
|
</summary>
|
<param name="factory">The extension method argument.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> so that additional calls can be chained.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Logging.EventSourceLoggerFactoryExtensions.AddEventSourceLogger(Microsoft.Extensions.Logging.ILoggingBuilder)">
|
<summary>
|
Adds an logger that writes messages to the <see cref="T:Microsoft.Extensions.Logging.EventSource.LoggingEventSource"/> instance.
|
</summary>
|
<param name="builder">The extension method argument.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
|
</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="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
|
<summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
|
<param name="argument">The reference type argument to validate as non-null.</param>
|
<param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
|
</member>
|
<member name="M:System.ThrowHelper.IfNullOrWhitespace(System.String,System.String)">
|
<summary>
|
Throws either an <see cref="T:System.ArgumentNullException"/> or an <see cref="T:System.ArgumentException"/>
|
if the specified string is <see langword="null"/> or whitespace respectively.
|
</summary>
|
<param name="argument">String to be checked for <see langword="null"/> or whitespace.</param>
|
<param name="paramName">The name of the parameter being checked.</param>
|
<returns>The original value of <paramref name="argument"/>.</returns>
|
</member>
|
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
<summary>
|
Attribute used to indicate a source generator should create a function for marshalling
|
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
</summary>
|
<remarks>
|
This attribute is meaningless if the source generator associated with it is not enabled.
|
The current built-in source generator only supports C# and only supplies an implementation when
|
applied to static, partial, non-generic methods.
|
</remarks>
|
</member>
|
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
<summary>
|
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
</summary>
|
<param name="libraryName">Name of the library containing the import.</param>
|
</member>
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
<summary>
|
Gets the name of the library containing the import.
|
</summary>
|
</member>
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
<summary>
|
Gets or sets the name of the entry point to be called.
|
</summary>
|
</member>
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
<summary>
|
Gets or sets how to marshal string arguments to the method.
|
</summary>
|
<remarks>
|
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
</remarks>
|
</member>
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
<summary>
|
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
</summary>
|
<remarks>
|
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
</remarks>
|
</member>
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
<summary>
|
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
on other platforms) before returning from the attributed method.
|
</summary>
|
</member>
|
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
<summary>
|
Specifies how strings should be marshalled for generated p/invokes
|
</summary>
|
</member>
|
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
<summary>
|
Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
</summary>
|
</member>
|
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
<summary>
|
Use the platform-provided UTF-8 marshaller.
|
</summary>
|
</member>
|
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
<summary>
|
Use the platform-provided UTF-16 marshaller.
|
</summary>
|
</member>
|
<member name="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute">
|
<summary>
|
States a dependency that one member has on another.
|
</summary>
|
<remarks>
|
This can be used to inform tooling of a dependency that is otherwise not evident purely from
|
metadata and IL, for example a member relied on via reflection.
|
</remarks>
|
</member>
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.String)">
|
<summary>
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
|
with the specified signature of a member on the same type as the consumer.
|
</summary>
|
<param name="memberSignature">The signature of the member depended on.</param>
|
</member>
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.String,System.Type)">
|
<summary>
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
|
with the specified signature of a member on a <see cref="T:System.Type"/>.
|
</summary>
|
<param name="memberSignature">The signature of the member depended on.</param>
|
<param name="type">The <see cref="T:System.Type"/> containing <paramref name="memberSignature"/>.</param>
|
</member>
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.String,System.String,System.String)">
|
<summary>
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
|
with the specified signature of a member on a type in an assembly.
|
</summary>
|
<param name="memberSignature">The signature of the member depended on.</param>
|
<param name="typeName">The full name of the type containing the specified member.</param>
|
<param name="assemblyName">The assembly name of the type containing the specified member.</param>
|
</member>
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes,System.Type)">
|
<summary>
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
|
with the specified types of members on a <see cref="T:System.Type"/>.
|
</summary>
|
<param name="memberTypes">The types of members depended on.</param>
|
<param name="type">The <see cref="T:System.Type"/> containing the specified members.</param>
|
</member>
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes,System.String,System.String)">
|
<summary>
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
|
with the specified types of members on a type in an assembly.
|
</summary>
|
<param name="memberTypes">The types of members depended on.</param>
|
<param name="typeName">The full name of the type containing the specified members.</param>
|
<param name="assemblyName">The assembly name of the type containing the specified members.</param>
|
</member>
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature">
|
<summary>
|
Gets the signature of the member depended on.
|
</summary>
|
<remarks>
|
Either <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature"/> must be a valid string or <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes"/>
|
must not equal <see cref="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None"/>, but not both.
|
</remarks>
|
</member>
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes">
|
<summary>
|
Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
|
of members depended on.
|
</summary>
|
<remarks>
|
Either <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature"/> must be a valid string or <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes"/>
|
must not equal <see cref="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None"/>, but not both.
|
</remarks>
|
</member>
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type">
|
<summary>
|
Gets the <see cref="T:System.Type"/> containing the specified member.
|
</summary>
|
<remarks>
|
If neither <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type"/> nor <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName"/> are specified,
|
the type of the consumer is assumed.
|
</remarks>
|
</member>
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName">
|
<summary>
|
Gets the full name of the type containing the specified member.
|
</summary>
|
<remarks>
|
If neither <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type"/> nor <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName"/> are specified,
|
the type of the consumer is assumed.
|
</remarks>
|
</member>
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.AssemblyName">
|
<summary>
|
Gets the assembly name of the specified type.
|
</summary>
|
<remarks>
|
<see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.AssemblyName"/> is only valid when <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName"/> is specified.
|
</remarks>
|
</member>
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Condition">
|
<summary>
|
Gets or sets the condition in which the dependency is applicable, e.g. "DEBUG".
|
</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.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>
|
</members>
|
</doc>
|
