EventLogRecord.FormatDescription Method

Definition

Namespace:

System.Diagnostics.Eventing.Reader

Assembly:

System.Diagnostics.EventLog.dll

Gets the event message.

Overloads

FormatDescription()	Gets the event message in the current locale.
FormatDescription(IEnumerable<Object>)	Gets the event message, replacing variables in the message with the specified values.

FormatDescription()

Gets the event message in the current locale.

public:
 override System::String ^ FormatDescription();

public override string FormatDescription ();

override this.FormatDescription : unit -> string

Public Overrides Function FormatDescription () As String

Returns

String

Returns a string that contains the event message in the current locale.

See also

• Technology Summary for Reading and Managing Event Logs
• Event Log Scenarios

FormatDescription(IEnumerable<Object>)

Gets the event message, replacing variables in the message with the specified values.

public:
 override System::String ^ FormatDescription(System::Collections::Generic::IEnumerable<System::Object ^> ^ values);

public override string FormatDescription (System.Collections.Generic.IEnumerable<object> values);

override this.FormatDescription : seq<obj> -> string

Public Overrides Function FormatDescription (values As IEnumerable(Of Object)) As String

Parameters

values

IEnumerable<Object>

The values used to replace variables in the event message. Variables are represented by %n, where n is a number.

Returns

String

Returns a string that contains the event message in the current locale.

See also

• Technology Summary for Reading and Managing Event Logs
• Event Log Scenarios