Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

InstallerCollection Class

Contains a collection of installers to be run during an installation.

For a list of all members of this type, see InstallerCollection Members.

System.Object
   System.Collections.CollectionBase
      System.Configuration.Install.InstallerCollection

[Visual Basic]
Public Class InstallerCollection
   Inherits CollectionBase
[C#]
public class InstallerCollection : CollectionBase
[C++]
public __gc class InstallerCollection : public CollectionBase
[JScript]
public class InstallerCollection extends CollectionBase

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

The InstallerCollection provides the methods and properties that your application needs to manage a collection of Installer objects.

Use any of the following three ways to add installers to the collection:

  • The Add method adds a single installer to the collection.
  • The AddRange methods add multiple installers to the collection.
  • The Insert method and the Item property, which is the InstallerCollection indexer, each add a single installer to the collection at the specified index.

Remove installers through the Remove method. Check whether an installer is in the collection by using the Contains method. Find where an installer is located in the collection by using the IndexOf method.

The installers in a collection are run when the installer containing the collection, as specified by the Installer.Parent property, calls their Install, Commit, Rollback, or Uninstall methods.

For examples of the usage of an installer collection, see the AssemblyInstaller and TransactedInstaller classes.

Example

[Visual Basic, C#, C++] The following example demonstrates the Add method of the InstallerCollection class. 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 taken if there is a previous assembly in the list. If 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] 
Imports System
Imports System.ComponentModel
Imports System.Collections
Imports System.Configuration.Install
Imports System.IO

Public Class InstallerCollection_Add
   
   'Entry point which delegates to C-style main Private Function
   Public Overloads Shared Sub Main()
      Main(System.Environment.GetCommandLineArgs())
   End Sub
   
   Overloads Public Shared Sub Main(args() As String)
      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' a 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(" Error : {0} - Assembly file doesn't exist.", args(i))
                  Return
               End If
               ' Create an 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 an 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(" Exception raised : {0}", e.Message)
      End Try
   End Sub 'Main

   Public Shared Sub PrintHelpMessage()
      Console.WriteLine("Usage : InstallerCollection_Add [/u | /uninstall] [option [...]]assembly"+ _
                                                               "[[option [...]] assembly] [...]]")
      Console.WriteLine("InstallerCollection_Add executes the installers in each of" + _
      " the given assembly. If /u or /uninstall option is given it uninstalls the assemblies.")
   End Sub 'PrintHelpMessage
End Class 'InstallerCollection_Add

[C#] 
using System;
using System.ComponentModel;
using System.Collections;
using System.Configuration.Install;
using System.IO;

public class InstallerCollection_Add
{
   public static void Main(String[] args)
   {
      ArrayList options = 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' a 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.
               options.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(" Error : {0} - Assembly file doesn't exist.", args[i]);
                  return;
               }
               // Create an instance of 'AssemblyInstaller' that installs the given assembly.
               myAssemblyInstaller = new AssemblyInstaller(args[i],
                  (string[]) options.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 an instance of 'InstallContext' with the options specified.
         myInstallContext =
            new InstallContext("Install.log",
            (string[]) options.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(" Exception raised : {0}", e.Message);
      }
   }

   public static void PrintHelpMessage()
   {
      Console.WriteLine("Usage : InstallerCollection_Add [/u | /uninstall] [option [...]] assembly" +
         "[[option [...]] assembly] [...]]");
      Console.WriteLine("InstallerCollection_Add executes the installers in each of" +
         " the given assembly. If /u or /uninstall option" +
         " is given it uninstalls the assemblies.");
   }
}

[C++] 
#using <mscorlib.dll>
#using <System.dll>
#using <System.Configuration.Install.dll>

using namespace System;
using namespace System::ComponentModel;
using namespace System::Collections;
using namespace System::Configuration::Install;
using namespace System::IO;

void PrintHelpMessage() {
    Console::WriteLine(S"Usage : InstallerCollection_Add [/u | /uninstall] [option [...]] assembly [->Item[option [...]] assembly] [...]]");
    Console::WriteLine(S"InstallerCollection_Add executes the installers in each of  the given assembly. If /u or /uninstall");
    Console::WriteLine(S"option  is given it uninstalls the assemblies.");
}

int main() {
    String* args[] = Environment::GetCommandLineArgs();
    ArrayList* options = 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(S"/") || args[i]->StartsWith(S"-")) {
                myOption = args[i]->Substring(1);
                // Determine whether the option is to 'uninstall' a 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.
                        options->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" Error : {0} - Assembly file doesn't exist.", args[i]);
                    return 0;
                }
                // Create an instance of 'AssemblyInstaller' that installs the given assembly.
                myAssemblyInstaller = new AssemblyInstaller(args[i],
                    __try_cast<String*[]>(options->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 an instance of 'InstallContext' with the options specified.
        myInstallContext = new InstallContext(S"Install.log",
            __try_cast<String*[]>(options->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" Exception 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 Language Filter 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

InstallerCollection Members | System.Configuration.Install Namespace | Installer | Install | Commit | Rollback | Uninstall | AssemblyInstaller | TransactedInstaller

Show:
© 2015 Microsoft