Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

EventLogInstaller::Install Method

Performs the installation and writes event log information to the registry.

Namespace:  System.Diagnostics
Assembly:  System.Configuration.Install (in System.Configuration.Install.dll)
public:
virtual void Install(
	IDictionary^ stateSaver
) override

Parameters

stateSaver
Type: System.Collections::IDictionary

An IDictionary used to save information needed to perform a rollback or uninstall operation.

ExceptionCondition
PlatformNotSupportedException

The platform the installer is trying to use is not Windows NT 4.0 or later.

ArgumentException

The name specified in the Source property is already registered for a different event log.

The Install method writes event log information to the registry, and associates the event log with a log that is specified by the Log property. If the log does not already exist (and a source is specified), Install creates a log and associates the new source with it.

Typically, you do not call the methods of the EventLogInstaller from within your code; they are generally called only by the Installutil.exe (Installer Tool). The tool automatically calls the Install method during the installation process to write registry information that is associated with the event log being installed. Installation is transactional, so if there is a failure of any installation project component during the installation, all the previously-installed components are rolled back to their pre-installation states. This is accomplished by calling each component's Rollback method.

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 skips registering the source if the Source property matches a source name that is already registered for the same event log specified in the Log property.

An application's install routine uses the project installer's Installer::Context property to automatically maintain information about the components that have already been installed. This state information, which is passed to Install as the stateSaver parameter, is continuously updated as the tool installs each EventLogInstaller. Usually, it is not necessary for your code to explicitly modify this state information.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.