EventLogInstaller.Install(IDictionary) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Performs the installation and writes event log information to the registry.
public:
override void Install(System::Collections::IDictionary ^ stateSaver);public override void Install (System.Collections.IDictionary stateSaver);override this.Install : System.Collections.IDictionary -> unitPublic Overrides Sub Install (stateSaver As IDictionary)Parameters
- stateSaver
- IDictionary
An IDictionary used to save information needed to perform a rollback or uninstall operation.
Exceptions
The name specified in the Source property is already registered for a different event log.
Remarks
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.
