EventLogInstaller.Source Property

Definition

Namespace:

System.Diagnostics

Assembly:

System.Configuration.Install.dll

Gets or sets the source name to register with the log.

public:
 property System::String ^ Source { System::String ^ get(); void set(System::String ^ value); };

[System.ComponentModel.TypeConverter("System.Diagnostics.Design.StringValueConverter, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
public string Source { get; set; }

[<System.ComponentModel.TypeConverter("System.Diagnostics.Design.StringValueConverter, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>]
member this.Source : string with get, set

Public Property Source As String

Property Value

String

The name to register with the event log as a source of entries. The default is an empty string ("").

Attributes

TypeConverterAttribute

Remarks

The event source indicates what logs the event. It is often the name of the application, or the name of a component within a large application.

The installer uses the value of the Source property to register your application with the event log as a valid source of entries. A new source name cannot match an existing source name or an existing event log name. Each source can only write to one event log at a time; however, your application can use multiple sources to write to multiple event logs. For example, your application might require multiple sources configured for different event logs or different resource files.

Applications and services should write to the Application log or a custom log. Device drivers should write to the System log. If you do not specify a log name before the installer runs, the installer registers your source to the Application log. If you specify the name of a log that does not exist, the system registers the Source to that log, but the log is not created until the first entry is written to it.

Use EventLogInstaller to register a new source for a new or existing event log; do not use EventLogInstaller to change an existing source. The EventLogInstaller class does not modify the configuration properties of an existing source to match the specified installation properties. The Install method throws an exception if the Source property matches a source name that is registered for a different event log on the computer. The Install method does not register the source if the Source property matches a source name that is already registered for the same event log specified in the Log property.

For more detailed information about the behaviors of event logs and sources, see the EventLog class documentation for the Log and Source properties.

See also

• Source
• EventLog