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

Definition

Formats the message and creates a scope.

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

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

A disposable scope object. Can be null.

Examples

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

Applies to

Produto Versões
.NET 8 (package-provided), 9 (package-provided)
.NET Framework 4.7 (package-provided), 4.7.1 (package-provided), 4.7.2 (package-provided), 4.8 (package-provided)
.NET Standard 2.0 (package-provided)