LogicalThreadContextStack.Push Method

LogicalThreadContextStack Push Method

Apache log4net™ SDK Documentation

Pushes a new context message into this stack.

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

Syntax

public IDisposable Push(
	string message
)

public IDisposable Push(
	string message
)

Public Function Push ( 
	message As String
) As IDisposable

Public Function Push ( 
	message As String
) As IDisposable

public:
IDisposable^ Push(
	String^ message
)

public:
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

Pushes a new context onto this stack. An Online IDisposable is returned that can be used to clean up this 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.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message"))
{
    log.Warn("This should have an ThreadContext Stack message");
}

using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message"))
{
    log.Warn("This should have an ThreadContext Stack message");
}