System.Diagnostics.EventSourceCreationData.ParameterResourceFile Property

Gets or sets the path of the resource file that contains message parameter strings for the source.

Syntax

public string ParameterResourceFile { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Use the EventSourceCreationData.ParameterResourceFile property to configure an event log source to write localized event messages with inserted parameter strings. Each localized event message specified in the EventSourceCreationData.MessageResourceFile property can contain placeholders for insertion strings. These placeholders are used to specify the position and resource identifier for a language-independent string within the event message. The Event Viewer fills in the placeholders using the corresponding strings from the EventSourceCreationData.ParameterResourceFile and formats the event log message for the localized event entry.

For example, the following section of a message text file defines a string with a parameter placeholder:

Example

MessageId = 1501
Severity = Success
Facility = Application
SymbolicName = COMPONENT_STARTING
Language=English
Component %%6050 is starting.
.

Within the parameter resource file, the insertion string must be defined with the resource identifier that corresponds to the placeholder, as shown below:

Example

MessageId = 6050
Severity = Success
Facility = Application
SymbolicName = COMPONENT_NAME_MSGID
Language=English
TRIGGER.EXE
.

The event source must be configured either for writing localized entries or for writing direct strings. Use the erload:System.Diagnostics.EventLog.WriteEvent method to write localized entries for a source configured with a message resource file.

If your application writes event message strings directly to the event log, or if your EventSourceCreationData.MessageResourceFile property does not contain messages with parameter insertion placeholders, do not set the EventSourceCreationData.ParameterResourceFile property.

For details about defining event messages and building event resource files, see the "Message Compiler" topic in the Platform SDK documentation at tp://msdn.microsoft.com/.

Requirements

Namespace: System.Diagnostics
Assembly: System (in System.dll)
Assembly Versions: 2.0.0.0, 4.0.0.0
Since: .NET 2.0