NDC.Push Method

NDC Push Method

Apache log4net™ SDK Documentation

Pushes a new context message.

Namespace: log4net
Assembly: log4net (in log4net.dll) Version: 1.2.15.0 (1.2.15.0)

Syntax

public static IDisposable Push(
	string message
)

public static IDisposable Push(
	string message
)

Public Shared Function Push ( 
	message As String
) As IDisposable

Public Shared Function Push ( 
	message As String
) As IDisposable

public:
static IDisposable^ Push(
	String^ message
)

public:
static IDisposable^ Push(
	String^ message
)

Parameters

message: Type: System String
The new context message.

Return Value

Type:

IDisposable
An Online

IDisposable that can be used to clean up the context stack.

Remarks

Note
The NDC is deprecated and has been replaced by the Stacks. The current NDC implementation forwards to the ThreadContext.Stacks["NDC"].

Pushes a new context onto the context stack. An Online IDisposable is returned that can be used to clean up the context stack. This can be easily combined with the using keyword to scope the context.

Examples

Simple example of using the Push method with the using keyword.

C++

Copy to Clipboard Print

using(log4net.NDC.Push("NDC_Message"))
{
    log.Warn("This should have an NDC message");
}

using(log4net.NDC.Push("NDC_Message"))
{
    log.Warn("This should have an NDC message");
}