LogContext Class

Provides the context for logging asynchronous events.

Inheritance Hierarchy

System.Object
  CMS.EventLog.LogContext

Namespace: CMS.EventLog
Assembly: CMS.EventLog (in CMS.EventLog.dll) Version: 9.0.0

Syntax

public class LogContext : ILogContext, INotCopyThreadItem

The LogContext type exposes the following members.

Constructors

	Name	Description
Public method	LogContext()	Constructor - Registers the context within request.
Public method	LogContext(Guid)	Constructor - Registers the context within request.

Fields

	Name	Description
Protected field	mEvent	Info object containing event.
Protected field	mLog	Current log.
Protected field	mLogGuid	Logs GUID.
Protected field Static member	mLogs	Table of existing logs [GUID] -> [LogContext]
Protected field	mLogSingleEvents	Indicates whether to log events one by one to event log.
Protected field	mMultipleOperationEventCode	Explicit event log code used when LogSingleEvents is false (case of multiple logging).

Properties

	Name	Description
Public property Static member	Current	Gets or sets current log context.
Public property	Event	Info object of type EventLogInfo.
Public property	EventURL	URL of event.
Public property	IPAddress	IP address of client.
Public property	Log	Gets the current log.
Public property	LogAlways	If true, the context always logs regardless of the action context settings
Public property	LogGuid	Logs guid.
Public property	LogSingleEvents	Indicates whether to log events one by one to event log.
Public property	MachineName	Name of machine.
Public property	MaxLength	Maximum length of the log. If the length is exceeded, the log is trimmed to half, offset is set and the log continues.
Public property	MultipleOperationEventCode	Explicit event log code used when LogSingleEvents is false (case of multiple logging).
Public property	Offset	Offset of a partial log in a complete log
Public property	UrlReferrer	Referrer url.
Public property	UserAgent	Browser identification.

Methods

	Name	Description
Public method Static member	Append	Appends text to the log.
Public method Static member	AppendLine	Appends text to the log.
Public method	AppendText	Appends the text.
Public method	Clear	Clears the log
Public method	Close	Closes the log.
Public method Static member	CloseCurrent	Drops the current log context.
Public method Static member	CloseLog	Closes given log context.
Public method Static member	EnsureLog	Ensures the log for given GUID.
Public method Static member	LogEvent	Writes a new record to the event log.
Public method Static member	LogExists	Returns true if the given log exists.
Protected method	RaiseOnChanged	Fires the onchanged event.
Public method	SetAllowedContexts	Sets the list of the context names that the log context accepts. Use empty string for context which logs messages that do not provide context.

Events

	Name	Description
Public event	OnChanged	Fires when the log has changed.
Public event	TextAppended	Event which fires if some text is appended to the log