Installer クラスとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

Installer クラス

カスタムインストールに利用できる基本機能を提供します。

名前空間: System.Configuration.Install
アセンブリ: System.Configuration.Install (system.configuration.install.dll 内)
構文

Visual Basic (宣言)

Public Class Installer
    Inherits Component

Visual Basic (使用法)

Dim instance As Installer

public class Installer : Component

C++

public ref class Installer : public
 Component

public class Installer extends Component

JScript

public class Installer extends
 Component

解説

このクラスは、.NET Framework におけるカスタムインストーラすべての基本クラスです。インストーラは、コンピュータへのアプリケーションのインストールを支援するコンポーネントです。

Installer を使用するには、以下の手順を実行する必要があります。

Installer クラスから継承します。
Install、Commit、Rollback、Uninstall の各メソッドをオーバーライドします。
RunInstallerAttribute を派生クラスに追加し、その値を true に設定します。
派生クラスおよびインストールするアプリケーションをアセンブリに配置します。
インストーラを起動します。たとえば、InstallUtil.exe を使用してインストーラを起動します。

Installers プロパティは、インストーラのコレクションを格納します。Installer のインスタンスがインストーラコレクションの一部である場合、Parent プロパティに、そのコレクションを格納する Installer インスタンスが設定されます。Installers コレクションの使用例については、AssemblyInstaller クラスのトピックを参照してください。

Installer クラスの Install、Commit、Rollback、Uninstall の各メソッドは、Installers プロパティに格納されているコレクション内のインストーラに順次アクセスし、各インストーラに対応するメソッドを呼び出します。

Install、Commit、Rollback、Uninstall の各メソッドは、同じ Installer インスタンスに対して呼び出されるとは限りません。たとえば、Installer インスタンスを使用してアプリケーションをインストールしてコミットした後で、そのインスタンスへの参照は解放します。後からそのアプリケーションをアンインストールするときには、新しい Installer インスタンスへの参照が作成されます。つまり、Uninstall メソッドは、Installer の別のインスタンスに対して呼び出されることになります。このため、派生クラスでは、コンピュータの状態をインストーラには保存しないでください。代わりに、IDictionary を使用してください。ディクショナリに保存した情報は、各種の呼び出しにわたって維持され、Install、Commit、Rollback、Uninstall の各メソッドに渡されます。

状態を保存する IDictionary に情報を保存する必要がある 2 つの状況を次に示します。まず、インストーラが 1 つのレジストリキーを設定するとします。この場合、キーの元の値を IDictionary に保存します。これにより、インストールがロールバックされた場合に元の値を復元できます。2 つ目の状況として、インストーラが既存のファイルを置換すると想定します。既存のファイルを一時ディレクトリに保存し、そのファイルの新しい位置を IDictionary に保存します。これにより、インストールがロールバックされた場合は、新しいファイルを削除して、一時ディレクトリ内の元のファイルで置換できます。

Installer.Context プロパティは、インストールに関する情報を格納します。たとえば、インストールに関するログファイルの位置、Uninstall メソッドが必要とする情報を保存するファイルの位置、インストール実行可能ファイルが実行されたときに入力されたコマンドラインなどの情報が格納されます。

使用例

Installer クラスを使用する例を次に示します。この例では、Installer から継承するクラスを作成します。Commit が完了するときに Committing イベントが発生し、メッセージが表示されます。

Visual Basic

Imports System
Imports System.Collections
Imports System.ComponentModel
Imports System.Configuration.Install

' Set 'RunInstaller' attribute to true.
<RunInstaller(True)> _
Public Class MyInstallerClass
   Inherits Installer

   Public Sub New()
       MyBase.New()
      ' Attach the 'Committed' event.
      AddHandler Me.Committed, AddressOf
 MyInstaller_Committed
      ' Attach the 'Committing' event.
      AddHandler Me.Committing, AddressOf
 MyInstaller_Committing
   End Sub 'New

   ' Event handler for 'Committing' event.
   Private Sub MyInstaller_Committing(ByVal
 sender As Object, _
                                      ByVal e As
 InstallEventArgs)
      Console.WriteLine("")
      Console.WriteLine("Committing Event occured.")
      Console.WriteLine("")
   End Sub 'MyInstaller_Committing

   ' Event handler for 'Committed' event.
   Private Sub MyInstaller_Committed(ByVal
 sender As Object, _
                                     ByVal e As
 InstallEventArgs)
      Console.WriteLine("")
      Console.WriteLine("Committed Event occured.")
      Console.WriteLine("")
   End Sub 'MyInstaller_Committed

   ' Override the 'Install' method.
   Public Overrides Sub
 Install(ByVal savedState As IDictionary)
      MyBase.Install(savedState)
   End Sub 'Install

   ' Override the 'Commit' method.
   Public Overrides Sub
 Commit(ByVal savedState As IDictionary)
      MyBase.Commit(savedState)
   End Sub 'Commit

   ' Override the 'Rollback' method.
   Public Overrides Sub
 Rollback(ByVal savedState As IDictionary)
      MyBase.Rollback(savedState)
   End Sub 'Rollback
   Public Shared Sub Main()
      Console.WriteLine("Usage : installutil.exe Installer.exe
 ")
   End Sub 'Main
End Class 'MyInstallerClass

using System;
using System.Collections;
using System.ComponentModel;
using System.Configuration.Install;

// Set 'RunInstaller' attribute to true.
[RunInstaller(true)]
public class MyInstallerClass: Installer
{
   public MyInstallerClass() :base()
   {
      // Attach the 'Committed' event.
      this.Committed += new InstallEventHandler(MyInstaller_Committed);
      // Attach the 'Committing' event.
      this.Committing += new InstallEventHandler(MyInstaller_Committing);

   }
   // Event handler for 'Committing' event.
   private void MyInstaller_Committing(object
 sender, InstallEventArgs e)
   {
      Console.WriteLine("");
      Console.WriteLine("Committing Event occured.");
      Console.WriteLine("");
   }
   // Event handler for 'Committed' event.
   private void MyInstaller_Committed(object
 sender, InstallEventArgs e)
   {
      Console.WriteLine("");
      Console.WriteLine("Committed Event occured.");
      Console.WriteLine("");
   }
   // Override the 'Install' method.
   public override void Install(IDictionary
 savedState)
   {
      base.Install(savedState);
   }
   // Override the 'Commit' method.
   public override void Commit(IDictionary
 savedState)
   {
      base.Commit(savedState);
   }
   // Override the 'Rollback' method.
   public override void Rollback(IDictionary
 savedState)
   {
      base.Rollback(savedState);
   }
   public static void Main()
   {
      Console.WriteLine("Usage : installutil.exe Installer.exe ");
   }
}

C++

#using <System.dll>
#using <System.Configuration.Install.dll>

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

// Set 'RunInstaller' attribute to true.

[RunInstaller(true)]
ref class MyInstallerClass: public Installer
{
private:

   // Event handler for 'Committing' event.
   void MyInstaller_Committing( Object^ sender, InstallEventArgs^
 e )
   {
      Console::WriteLine( "" );
      Console::WriteLine( "Committing Event occured." );
      Console::WriteLine( "" );
   }


   // Event handler for 'Committed' event.
   void MyInstaller_Committed( Object^ sender, InstallEventArgs^
 e )
   {
      Console::WriteLine( "" );
      Console::WriteLine( "Committed Event occured." );
      Console::WriteLine( "" );
   }


public:
   MyInstallerClass()
   {
      
      // Attach the 'Committed' event.
      this->Committed += gcnew InstallEventHandler( this,
 &MyInstallerClass::MyInstaller_Committed );
      
      // Attach the 'Committing' event.
      this->Committing += gcnew InstallEventHandler( this,
 &MyInstallerClass::MyInstaller_Committing );
   }


   // Override the 'Install' method.
   virtual void Install( IDictionary^ savedState ) override
   {
      Installer::Install( savedState );
   }


   // Override the 'Commit' method.
   virtual void Commit( IDictionary^ savedState ) override
   {
      Installer::Commit( savedState );
   }


   // Override the 'Rollback' method.
   virtual void Rollback( IDictionary^ savedState ) override
   {
      Installer::Rollback( savedState );
   }

};

int main()
{
   Console::WriteLine( "Usage : installutil.exe Installer.exe " );
}

import System.*;
import System.Collections.*;
import System.ComponentModel.*;
import System.Configuration.Install.*;

// Set 'RunInstaller' attribute to true.
/** @attribute RunInstaller(true)
 */
public class MyInstallerClass extends Installer
{
    public MyInstallerClass()
    {
        // Attach the 'Committed' event.
        this.add_Committed(new InstallEventHandler(MyInstaller_Committed));

        // Attach the 'Committing' event.
        this.add_Committing(new InstallEventHandler(MyInstaller_Committing));
    } //MyInstallerClass

    // Event handler for 'Committing' event.
    private void MyInstaller_Committing(Object
 sender, InstallEventArgs e)
    {
        Console.WriteLine("");
        Console.WriteLine("Committing Event occured.");
        Console.WriteLine("");
    } //MyInstaller_Committing

    // Event handler for 'Committed' event.
    private void MyInstaller_Committed(Object
 sender, InstallEventArgs e)
    {
        Console.WriteLine("");
        Console.WriteLine("Committed Event occured.");
        Console.WriteLine("");
    } //MyInstaller_Committed

    // Override the 'Install' method.
    public void Install(IDictionary savedState)
    {
        super.Install(savedState);
    } //Install

    // Override the 'Commit' method.
    public void Commit(IDictionary savedState)
    {
        super.Commit(savedState);
    } //Commit

    // Override the 'Rollback' method.
    public void Rollback(IDictionary savedState)
    {
        super.Rollback(savedState);
    } //Rollback

    public static void main(String[]
 args)
    {
        Console.WriteLine("Usage : installutil.exe Installer.exe ");
    } //main
} //MyInstallerClass

継承階層

System.Object
   System.MarshalByRefObject
     System.ComponentModel.Component
      System.Configuration.Install.Installer
         System.Configuration.Install.AssemblyInstaller
         System.Configuration.Install.ComponentInstaller
         System.Configuration.Install.TransactedInstaller
         System.Management.Instrumentation.DefaultManagementProjectInstaller
         System.Management.Instrumentation.ManagementInstaller

スレッドセーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッドセーフです。インスタンスメンバの場合は、スレッドセーフであるとは限りません。

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
Installer メンバ
System.Configuration.Install 名前空間
AssemblyInstaller クラス
ComponentInstaller クラス
InstallerCollection
TransactedInstaller
その他の技術情報
インストーラツール (Installutil.exe)

>> 「Installer クラス」を含む用語の索引
Installer クラスのページへのリンク

Installer クラスとは？わかりやすく解説