Export (0) Print
Expand All

TransactedInstaller Class

Defines an installer that either succeeds completely or fails and leaves the computer in its initial state.

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Configuration.Install.Installer
        System.Configuration.Install.TransactedInstaller

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

public class TransactedInstaller : Installer

The TransactedInstaller type exposes the following members.

  NameDescription
Public methodTransactedInstallerInitializes a new instance of the TransactedInstaller class.
Top

  NameDescription
Protected propertyCanRaiseEventsGets a value indicating whether the component can raise an event. (Inherited from Component.)
Public propertyContainerGets the IContainer that contains the Component. (Inherited from Component.)
Public propertyContextGets or sets information about the current installation. (Inherited from Installer.)
Protected propertyDesignModeGets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Protected propertyEventsGets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public propertyHelpTextGets the help text for all the installers in the installer collection. (Inherited from Installer.)
Public propertyInstallersGets the collection of installers that this installer contains. (Inherited from Installer.)
Public propertyParentGets or sets the installer containing the collection that this installer belongs to. (Inherited from Installer.)
Public propertySiteGets or sets the ISite of the Component. (Inherited from Component.)
Top

  NameDescription
Public methodCommitWhen overridden in a derived class, completes the install transaction. (Inherited from Installer.)
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodDispose()Releases all resources used by the Component. (Inherited from Component.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeReleases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodGetServiceReturns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodInstallPerforms the installation. (Overrides Installer.Install(IDictionary).)
Protected methodMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected methodOnAfterInstallRaises the AfterInstall event. (Inherited from Installer.)
Protected methodOnAfterRollbackRaises the AfterRollback event. (Inherited from Installer.)
Protected methodOnAfterUninstallRaises the AfterUninstall event. (Inherited from Installer.)
Protected methodOnBeforeInstallRaises the BeforeInstall event. (Inherited from Installer.)
Protected methodOnBeforeRollbackRaises the BeforeRollback event. (Inherited from Installer.)
Protected methodOnBeforeUninstallRaises the BeforeUninstall event. (Inherited from Installer.)
Protected methodOnCommittedRaises the Committed event. (Inherited from Installer.)
Protected methodOnCommittingRaises the Committing event. (Inherited from Installer.)
Public methodRollbackWhen overridden in a derived class, restores the pre-installation state of the computer. (Inherited from Installer.)
Public methodToStringReturns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)
Public methodUninstallRemoves an installation. (Overrides Installer.Uninstall(IDictionary).)
Top

  NameDescription
Public eventAfterInstallOccurs after the Install methods of all the installers in the Installers property have run. (Inherited from Installer.)
Public eventAfterRollbackOccurs after the installations of all the installers in the Installers property are rolled back. (Inherited from Installer.)
Public eventAfterUninstallOccurs after all the installers in the Installers property perform their uninstallation operations. (Inherited from Installer.)
Public eventBeforeInstallOccurs before the Install method of each installer in the installer collection has run. (Inherited from Installer.)
Public eventBeforeRollbackOccurs before the installers in the Installers property are rolled back. (Inherited from Installer.)
Public eventBeforeUninstallOccurs before the installers in the Installers property perform their uninstall operations. (Inherited from Installer.)
Public eventCommittedOccurs after all the installers in the Installers property have committed their installations. (Inherited from Installer.)
Public eventCommittingOccurs before the installers in the Installers property committ their installations. (Inherited from Installer.)
Public eventDisposedOccurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Top

To run installers in a transaction, add them to the Installers property of this TransactedInstaller instance.

The following example demonstrates the TransactedInstaller, Install and Uninstall methods of the TransactedInstaller class.

This example provides an implementation similar to that of Installutil.exe (Installer Tool). It installs assemblies with the options preceding that particular assembly. If an option is not specified for an assembly, the previous assembly's options are used if there is a previous assembly in the list. If either the "/u" or "/uninstall" option is specified, the assemblies are uninstalled. If the "/?" or "/help" option is provided, the help information is displayed to the console.

ArrayList myOptions = new ArrayList();
String myOption;
bool toUnInstall = false;
bool toPrintHelp = false;
TransactedInstaller myTransactedInstaller = new TransactedInstaller();
AssemblyInstaller myAssemblyInstaller;
InstallContext myInstallContext;

try
{
   for(int i = 0; i < args.Length; i++)
   {
      // Process the arguments. 
      if(args[i].StartsWith("/") || args[i].StartsWith("-"))
      {
         myOption = args[i].Substring(1);
         // Determine whether the option is to 'uninstall' an assembly. 
         if(String.Compare(myOption, "u", true) == 0 ||
            String.Compare(myOption, "uninstall", true) == 0)
         {
            toUnInstall = true;
            continue;
         }
         // Determine whether the option is for printing help information. 
         if(String.Compare(myOption, "?", true) == 0 ||
            String.Compare(myOption, "help", true) == 0)
         {
            toPrintHelp = true;
            continue;
         }
         // Add the option encountered to the list of all options 
         // encountered for the current assembly.
         myOptions.Add(myOption);
      }
      else
      {
         // Determine whether the assembly file exists. 
         if(!File.Exists(args[i]))
         {
            // If assembly file doesn't exist then print error.
            Console.WriteLine("\nError : {0} - Assembly file doesn't exist.",
               args[i]);
            return;
         }

         // Create a instance of 'AssemblyInstaller' that installs the given assembly.
         myAssemblyInstaller = 
            new AssemblyInstaller(args[i], 
            (string[]) myOptions.ToArray(typeof(string)));
         // Add the instance of 'AssemblyInstaller' to the 'TransactedInstaller'.  
         myTransactedInstaller.Installers.Add(myAssemblyInstaller);
      }
   }
   // If user requested help or didn't provide any assemblies to install 
   // then print help message. 
   if(toPrintHelp || myTransactedInstaller.Installers.Count == 0)
   {
      PrintHelpMessage();
      return;
   }

   // Create a instance of 'InstallContext' with the options specified.
   myInstallContext = 
      new InstallContext("Install.log", 
      (string[]) myOptions.ToArray(typeof(string)));
   myTransactedInstaller.Context = myInstallContext;

   // Install or Uninstall an assembly depending on the option provided. 
   if(!toUnInstall)
      myTransactedInstaller.Install(new Hashtable());
   else
      myTransactedInstaller.Uninstall(null);
}
catch(Exception e)
{
   Console.WriteLine("\nException raised : {0}", e.Message);
}  

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft