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

Definition

Namespace:

Microsoft.Extensions.Logging

Assembly:

Microsoft.Extensions.Logging.Abstractions.dll

Package:

Microsoft.Extensions.Logging.Abstractions v9.0.0-rc.2.24473.5

Source:

LoggerExtensions.cs

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)) { }