TransactedInstaller Class
Defines an installer that either succeeds completely or fails and leaves the computer in its initial state.
For a list of all members of this type, see TransactedInstaller Members.
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
System.Configuration.Install.Installer
System.Configuration.Install.TransactedInstaller
[Visual Basic] Public Class TransactedInstaller Inherits Installer [C#] public class TransactedInstaller : Installer [C++] public __gc class TransactedInstaller : public Installer [JScript] public class TransactedInstaller extends Installer
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Remarks
To run installers in a transaction, add them to the Installers property of this TransactedInstaller instance.
Example
[Visual Basic, C#, C++] The following example demonstrates the TransactedInstaller, Install and Uninstall methods of the TransactedInstaller class.
[Visual Basic, C#, C++] This example provides an implementation similar to that of Installer Tool (Installutil.exe). 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.
[Visual Basic] Dim options As New ArrayList() Dim myOption As String Dim toUnInstall As Boolean = False Dim toPrintHelp As Boolean = False Dim myTransactedInstaller As New TransactedInstaller() Dim myAssemblyInstaller As AssemblyInstaller Dim myInstallContext As InstallContext Try Dim i As Integer For i = 1 To args.Length - 1 ' Process the arguments. If args(i).StartsWith("/") Or args(i).StartsWith("-") Then myOption = args(i).Substring(1) ' Determine whether the option is to 'uninstall' an assembly. If String.Compare(myOption, "u", True) = 0 Or _ String.Compare(myOption,"uninstall", True) = 0 Then toUnInstall = True GoTo ContinueFor1 End If ' Determine whether the option is for printing help information. If String.Compare(myOption, "?", True) = 0 Or _ String.Compare(myOption, "help", True) = 0 Then toPrintHelp = True GoTo ContinueFor1 End If ' Add the option encountered to the list of all options ' encountered for the current assembly. options.Add(myOption) Else ' Determine whether the assembly file exists. If Not File.Exists(args(i)) Then ' If assembly file doesn't exist then print error. Console.WriteLine(ControlChars.Newline + _ "Error : {0} - Assembly file doesn't exist.", args(i)) Return End If ' Create a instance of 'AssemblyInstaller' that installs the given assembly. myAssemblyInstaller = New AssemblyInstaller(args(i), _ CType(options.ToArray(GetType(String)), String())) ' Add the instance of 'AssemblyInstaller' to the 'TransactedInstaller'. myTransactedInstaller.Installers.Add(myAssemblyInstaller) End If ContinueFor1: Next i ' If user requested help or didn't provide any assemblies to install ' then print help message. If toPrintHelp Or myTransactedInstaller.Installers.Count = 0 Then PrintHelpMessage() Return End If ' Create a instance of 'InstallContext' with the options specified. myInstallContext = New InstallContext("Install.log", _ CType(options.ToArray(GetType(String)), String())) myTransactedInstaller.Context = myInstallContext ' Install or Uninstall an assembly depending on the option provided. If Not toUnInstall Then myTransactedInstaller.Install(New Hashtable()) Else myTransactedInstaller.Uninstall(Nothing) End If Catch e As Exception Console.WriteLine(ControlChars.Newline + "Exception raised : {0}", e.Message) End Try [C#] 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); } [C++] String* args[] = Environment::GetCommandLineArgs(); ArrayList* myOptions = new ArrayList(); String* myOption; bool toUnInstall = false; bool toPrintHelp = false; TransactedInstaller* myTransactedInstaller = new TransactedInstaller(); AssemblyInstaller* myAssemblyInstaller; InstallContext* myInstallContext; try { for (int i = 1; i < args->Length; i++) { // Process the arguments. if (args[i]->StartsWith(S"/") || args[i]->StartsWith(S"-")) { myOption = args[i]->Substring(1); // Determine whether the option is to 'uninstall' an assembly. if (String::Compare(myOption, S"u", true) == 0 || String::Compare(myOption, S"uninstall", true) == 0) { toUnInstall = true; continue; } // Determine whether the option is for printing help information. if (String::Compare(myOption, S"?", true) == 0 || String::Compare(myOption, S"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(S"\nError : {0} - Assembly file doesn't exist.", args[i]); return 0; } // Create a instance of 'AssemblyInstaller' that installs the given assembly. myAssemblyInstaller = new AssemblyInstaller(args[i], __try_cast<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 0; } // Create a instance of 'InstallContext' with the options specified. myInstallContext = new InstallContext(S"Install.log", __try_cast<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(0); } catch (Exception* e) { Console::WriteLine(S"\nException raised : {0}", e->Message); }
[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button
in the upper-left corner of the page.
Requirements
Namespace: System.Configuration.Install
Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family
Assembly: System.Configuration.Install (in System.Configuration.Install.dll)
See Also
TransactedInstaller Members | System.Configuration.Install Namespace