PrepString Method

AlignedTextWriterTraceListener PrepString Method

CleanCode C# Libraries v1.2.03 API

Prepares an output string for writing to the Online

TextWriter.

Namespace: CleanCode.Diagnostics
Assembly: CleanCode (in CleanCode.dll) Version: 1.2.3.0 (1.2.03)

Syntax

C++

Copy to Clipboard Print

protected string PrepString(
	TraceEventCache eventCache,
	string source,
	TraceEventType eventType,
	int id,
	string message
)

protected string PrepString(
	TraceEventCache eventCache,
	string source,
	TraceEventType eventType,
	int id,
	string message
)

Protected Function PrepString ( _
	eventCache As TraceEventCache, _
	source As String, _
	eventType As TraceEventType, _
	id As Integer, _
	message As String _
) As String

Protected Function PrepString ( _
	eventCache As TraceEventCache, _
	source As String, _
	eventType As TraceEventType, _
	id As Integer, _
	message As String _
) As String

protected:
String^ PrepString(
	TraceEventCache^ eventCache, 
	String^ source, 
	TraceEventType eventType, 
	int id, 
	String^ message
)

protected:
String^ PrepString(
	TraceEventCache^ eventCache, 
	String^ source, 
	TraceEventType eventType, 
	int id, 
	String^ message
)

Parameters

eventCache: Type: System.Diagnostics TraceEventCache
The event cache.

source: Type: System String
The name of the TraceSource.

eventType: Type: System.Diagnostics TraceEventType
The event type.

id: Type: System Int32
The event ID.

message: Type: System String
The message.

Return Value

An event log record.

Remarks

This method formats the output record based on the enabled output options and the field widths. Any subclass should make use of this method to properly format an event record in the style of an AlignedTextWriterTraceListener.