FakeLogRecord.StructuredState Property

Reference

Definition

Namespace:: Microsoft.Extensions.Logging.Testing

Assembly:: Microsoft.Extensions.Diagnostics.Testing.dll

Package:: Microsoft.Extensions.Diagnostics.Testing v9.0.0

Source:: FakeLogRecord.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the opaque state supplied by the caller when creating the log record as a read-only list.

public:
 property System::Collections::Generic::IReadOnlyList<System::Collections::Generic::KeyValuePair<System::String ^, System::String ^>> ^ StructuredState { System::Collections::Generic::IReadOnlyList<System::Collections::Generic::KeyValuePair<System::String ^, System::String ^>> ^ get(); };

public System.Collections.Generic.IReadOnlyList<System.Collections.Generic.KeyValuePair<string,string?>>? StructuredState { get; }

member this.StructuredState : System.Collections.Generic.IReadOnlyList<System.Collections.Generic.KeyValuePair<string, string>>

Public ReadOnly Property StructuredState As IReadOnlyList(Of KeyValuePair(Of String, String))

Property Value

IReadOnlyList<KeyValuePair<String,String>>

Exceptions

InvalidCastException

The state object is not compatible with supported logging model and is not a read-only list.

Remarks

When logging using the code generator logging model, the arguments you supply to the logging method are packaged into a single state object which is delivered to the Log<TState>(LogLevel, EventId, TState, Exception, Func<TState,Exception,String>) method. This state can be retrieved as a set of name/value pairs encoded in a read-only list.

The object returned by this property is the same as what State returns, except it has been cast to a read-only list.

Applies to

Freigeben über