LoggerExtensions.BeginScope(ILogger, String, Object[]) Method

Reference

Definition

Namespace:: Microsoft.Extensions.Logging

Assembly:: Microsoft.Extensions.Logging.Abstractions.dll

Package:: Microsoft.Extensions.Logging.Abstractions v9.0.0

Source:: LoggerExtensions.cs

Source:: LoggerExtensions.cs

Source:: LoggerExtensions.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.

Formats the message and creates a scope.

public:
[System::Runtime::CompilerServices::Extension]
 static IDisposable ^ BeginScope(Microsoft::Extensions::Logging::ILogger ^ logger, System::String ^ messageFormat, ... cli::array <System::Object ^> ^ args);

public static IDisposable? BeginScope (this Microsoft.Extensions.Logging.ILogger logger, string messageFormat, params object?[] args);

static member BeginScope : Microsoft.Extensions.Logging.ILogger * string * obj[] -> IDisposable

<Extension()>
Public Function BeginScope (logger As ILogger, messageFormat As String, ParamArray args As Object()) As IDisposable

Parameters

logger: ILogger

The ILogger to create the scope in.

messageFormat: String

Format string of the log message in message template format. Example: "User {User} logged in from {Address}".

args: Object[]

An object array that contains zero or more objects to format.

Returns

IDisposable

A disposable scope object. Can be null.

Examples

using(logger.BeginScope("Processing request from {Address}", address)) { }

Applies to

Share via