This topic has not yet been rated - Rate this topic

Installer.OnCommitting Method

.NET Framework 3.5

Raises the Committing event.

Namespace: System.Configuration.Install
Assembly: System.Configuration.Install (in System.Configuration.Install.dll)

Syntax

C++

JScript

protected virtual void OnCommitting(
	IDictionary savedState
)

Parameters

savedState: Type: System.Collections.IDictionary
An IDictionary that contains the state of the computer before the installers in the Installers property are committed.

Remarks

This method is called before the Commit methods of the installers in this instance's InstallerCollection run.

Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

The OnCommitting method allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors:

When overriding OnCommitting in a derived class, be sure to call the base class's OnCommitting method so that registered delegates receive the event.

Examples

The following example demonstrates the OnCommitting method of the Installer class. The OnCommitting method is overridden in the derived class. Space is provided for the user to add the steps to be performed before committing and after committing.

C++

// Override the 'OnCommitting' method. 
protected override void OnCommitting(IDictionary savedState)
{
   base.OnCommitting(savedState);
   // Add steps to be done before committing an application.
   Console.WriteLine("The OnCommitting method of MyInstaller called");
}

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

Version Information