Class NullTraceWriter

Implements a trace writer that is disabled and does not perform any recording.

Inheritance

object

NullTraceWriter

Implements

ITraceWriter

IDisposable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: Nevatech.Vsb.Repository.Diagnostics

Assembly: Nevatech.Vsb.Repository.dll

Syntax

public sealed class NullTraceWriter : ITraceWriter, IDisposable

Properties

Instance

Gets the singleton instance of the trace writer.

Declaration

public static NullTraceWriter Instance { get; }

Property Value

Type	Description
NullTraceWriter

IsEnabled

Gets flag indicating if tracing is enabled. Always returns false.

Declaration

public bool IsEnabled { get; }

Property Value

Type	Description
bool

Methods

Dispose()

Releases the internal resources.

Declaration

public void Dispose()

WriteCustomElement(string, string, IDictionary<string, string>)

Writes a custom XML element with provided name, text value, and attributes.

Declaration

[SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
public void WriteCustomElement(string name, string text, IDictionary<string, string> attributes = null)

Parameters

Type	Name	Description
string	name	Element name.
string	text	Optional element text (string value).
IDictionary<string, string>	attributes	Optional collection of XML attributes where key is the attribute name, and the value is the attribute value.

WriteEnd(TraceMark)

Writes the message indicating the ending of a component execution.

Declaration

public void WriteEnd(TraceMark startMark)

Parameters

Type	Name	Description
TraceMark	startMark	An object that was returned when the start message was recorded.

WriteEnd(TraceMark, Exception, string, params object[])

Writes the message indicating the failing of a component execution.

Declaration

[SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
public void WriteEnd(TraceMark startMark, Exception exception, string message = null, params object[] args)

Parameters

Type	Name	Description
TraceMark	startMark	An object that was returned when the start message was recorded.
Exception	exception	An exception that component has failed with.
string	message	Optional message clarifying the error.
object[]	args	Optional format parameters to the error message.

WriteEnd(TraceMark, object)

Writes the message indicating the ending of a component execution.

Declaration

public void WriteEnd(TraceMark startMark, object result)

Parameters

Type	Name	Description
TraceMark	startMark	An object that was returned when the start message was recorded.
object	result	The result of the component execution to be recorded.

WriteError(Exception, string, params object[])

Writes an exception details to the log.

Declaration

[SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
public void WriteError(Exception exception, string message = null, params object[] args)

Parameters

Type	Name	Description
Exception	exception	Exception to be recorded.
string	message	Optional message clarifying the error.
object[]	args	Optional format parameters to the error message.

WriteMessage(string, params object[])

Writes an arbitrary log message.

Declaration

public void WriteMessage(string message, params object[] args)

Parameters

Type	Name	Description
string	message	Message to be recorded.
object[]	args	Optional format parameters to the log message.

WriteStart(string, string)

Writes the message indicating the beginning of a component execution.

Declaration

[SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
public TraceMark WriteStart(string name, string id = null)

Parameters

Type	Name	Description
string	name	Name of the executing component.
string	id	Optional identifier of the executing component.

Returns

Type	Description
TraceMark	An object to be used for writing the ending of the component execution. It carries the component name and execution statistics.

WriteXml(string)

Writes an XML string to the log.

Declaration

public void WriteXml(string data)

Parameters

Type	Name	Description
string	data	XML string to be recorded.

Implements

ITraceWriter

IDisposable