installer

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

Installer イベント

パブリック イベント

	名前	説明
	AfterInstall	Installers プロパティ内のすべてのインストーラの Install メソッドが実行された後で発生します。
	AfterRollback	Installers プロパティ内のすべてのインストーラによるインストールがロールバックされた後で発生します。
	AfterUninstall	Installers プロパティ内のすべてのインストーラのアンインストールが実行された後で発生します。
	BeforeInstall	インストーラ コレクション内の各インストーラの Install メソッドが実行される前に発生します。
	BeforeRollback	Installers プロパティ内のインストーラによるインストールがロールバックされる前に発生します。
	BeforeUninstall	Installers プロパティ内のインストーラのアンインストールが実行される前に発生します。
	Committed	Installers プロパティ内のすべてのインストーラがインストールをコミットした後で発生します。
	Committing	Installers プロパティ内のインストーラがインストールをコミットする前に発生します。
	Disposed	コンポーネントの Disposed イベントを待機するイベント ハンドラを追加します。 ( Component から継承されます。)

参照

関連項目

Installer クラス
System.Configuration.Install 名前空間
AssemblyInstaller クラス
ComponentInstaller クラス
InstallerCollection
TransactedInstaller

その他の技術情報

インストーラ ツール (Installutil.exe)

Installer クラス

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

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

Visual Basic (宣言)

Public Class Installer
    Inherits Component

Visual Basic (使用法)

Dim instance As Installer

C#

public class Installer : Component

C++

public ref class Installer : public
 Component

J#

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

C#

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 " );
}

J#

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) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

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

参照

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

Installer コンストラクタ

Installer クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New Installer

C#

public Installer ()

C++

public:
Installer ()

J#

public Installer ()

JScript

public function Installer ()

.NET Framework のセキュリティ

• 直前の呼び出し元に対する完全な信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細については、「」を参照してください。

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

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

参照

関連項目
Installer クラス
Installer メンバ
System.Configuration.Install 名前空間

Installer プロパティ

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	Container	Component を格納している IContainer を取得します。 ( Component から継承されます。)
	Context	現在のインストールに関する情報を取得または設定します。
	HelpText	インストーラ コレクション内のすべてのインストーラに関するヘルプ テキストを取得します。
	Installers	インストーラが格納しているインストーラのコレクションを取得します。
	Parent	インストーラが属しているコレクションを格納しているインストーラを取得または設定します。
	Site	Component の ISite を取得または設定します。 ( Component から継承されます。)

プロテクト プロパティ

	名前	説明
	CanRaiseEvents	コンポーネントがイベントを発生させることがきるかどうかを示す値を取得します。 ( Component から継承されます。)
	DesignMode	Component が現在デザイン モードかどうかを示す値を取得します。 ( Component から継承されます。)
	Events	Component に結び付けられているイベント ハンドラのリストを取得します。 ( Component から継承されます。)

参照

関連項目

Installer クラス
System.Configuration.Install 名前空間
AssemblyInstaller クラス
ComponentInstaller クラス
InstallerCollection
TransactedInstaller

その他の技術情報

インストーラ ツール (Installutil.exe)

Installer メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Commit	派生クラスによってオーバーライドされた場合、インストール トランザクションを完了します。
	CreateObjRef	リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。 ( MarshalByRefObject から継承されます。)
	Dispose	オーバーロードされます。 Component によって使用されているリソースを解放します。 ( Component から継承されます。)
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービス オブジェクトを取得します。 ( MarshalByRefObject から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	InitializeLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、有効期間サービス オブジェクトを取得します。 ( MarshalByRefObject から継承されます。)
	Install	派生クラスによってオーバーライドされた場合、インストールを実行します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	Rollback	派生クラスによってオーバーライドされた場合、インストール前のコンピュータの状態を復元します。
	ToString	Component の名前を格納している String を返します (存在する場合)。このメソッドはオーバーライドできません。 ( Component から継承されます。)
	Uninstall	派生クラスによってオーバーライドされた場合、インストール内容を削除します。

プロテクト メソッド

	名前	説明
	Dispose	オーバーロードされます。 Component によって使用されているリソースを解放します。 ( Component から継承されます。)
	Finalize	Component がガベージ コレクションによってクリアされる前に、アンマネージ リソースを解放し、その他のクリーンアップ操作を実行します。 ( Component から継承されます。)
	GetService	Component またはその Container で提供されるサービスを表すオブジェクトを返します。 ( Component から継承されます。)
	MemberwiseClone	オーバーロードされます。 ( MarshalByRefObject から継承されます。)
	OnAfterInstall	AfterInstall イベントを発生させます。
	OnAfterRollback	AfterRollback イベントを発生させます。
	OnAfterUninstall	AfterUninstall イベントを発生させます。
	OnBeforeInstall	BeforeInstall イベントを発生させます。
	OnBeforeRollback	BeforeRollback イベントを発生させます。
	OnBeforeUninstall	BeforeUninstall イベントを発生させます。
	OnCommitted	Committed イベントを発生させます。
	OnCommitting	Committing イベントを発生させます。

参照

関連項目

Installer クラス
System.Configuration.Install 名前空間
AssemblyInstaller クラス
ComponentInstaller クラス
InstallerCollection
TransactedInstaller

その他の技術情報

インストーラ ツール (Installutil.exe)

Installer メンバ

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

Installer データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	Installer	Installer クラスの新しいインスタンスを初期化します。

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	Container	Component を格納している IContainer を取得します。(Component から継承されます。)
	Context	現在のインストールに関する情報を取得または設定します。
	HelpText	インストーラ コレクション内のすべてのインストーラに関するヘルプ テキストを取得します。
	Installers	インストーラが格納しているインストーラのコレクションを取得します。
	Parent	インストーラが属しているコレクションを格納しているインストーラを取得または設定します。
	Site	Component の ISite を取得または設定します。(Component から継承されます。)

プロテクト プロパティ

	名前	説明
	CanRaiseEvents	コンポーネントがイベントを発生させることがきるかどうかを示す値を取得します。(Component から継承されます。)
	DesignMode	Component が現在デザイン モードかどうかを示す値を取得します。(Component から継承されます。)
	Events	Component に結び付けられているイベント ハンドラのリストを取得します。(Component から継承されます。)

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Commit	派生クラスによってオーバーライドされた場合、インストール トランザクションを完了します。
	CreateObjRef	リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。 (MarshalByRefObject から継承されます。)
	Dispose	オーバーロードされます。 Component によって使用されているリソースを解放します。 (Component から継承されます。)
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービス オブジェクトを取得します。 (MarshalByRefObject から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	InitializeLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、有効期間サービス オブジェクトを取得します。 (MarshalByRefObject から継承されます。)
	Install	派生クラスによってオーバーライドされた場合、インストールを実行します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	Rollback	派生クラスによってオーバーライドされた場合、インストール前のコンピュータの状態を復元します。
	ToString	Component の名前を格納している String を返します (存在する場合)。このメソッドはオーバーライドできません。 (Component から継承されます。)
	Uninstall	派生クラスによってオーバーライドされた場合、インストール内容を削除します。

プロテクト メソッド

	名前	説明
	Dispose	オーバーロードされます。 Component によって使用されているリソースを解放します。 (Component から継承されます。)
	Finalize	Component がガベージ コレクションによってクリアされる前に、アンマネージ リソースを解放し、その他のクリーンアップ操作を実行します。 (Component から継承されます。)
	GetService	Component またはその Container で提供されるサービスを表すオブジェクトを返します。 (Component から継承されます。)
	MemberwiseClone	オーバーロードされます。 ( MarshalByRefObject から継承されます。)
	OnAfterInstall	AfterInstall イベントを発生させます。
	OnAfterRollback	AfterRollback イベントを発生させます。
	OnAfterUninstall	AfterUninstall イベントを発生させます。
	OnBeforeInstall	BeforeInstall イベントを発生させます。
	OnBeforeRollback	BeforeRollback イベントを発生させます。
	OnBeforeUninstall	BeforeUninstall イベントを発生させます。
	OnCommitted	Committed イベントを発生させます。
	OnCommitting	Committing イベントを発生させます。

パブリック イベント

	名前	説明
	AfterInstall	Installers プロパティ内のすべてのインストーラの Install メソッドが実行された後で発生します。
	AfterRollback	Installers プロパティ内のすべてのインストーラによるインストールがロールバックされた後で発生します。
	AfterUninstall	Installers プロパティ内のすべてのインストーラのアンインストールが実行された後で発生します。
	BeforeInstall	インストーラ コレクション内の各インストーラの Install メソッドが実行される前に発生します。
	BeforeRollback	Installers プロパティ内のインストーラによるインストールがロールバックされる前に発生します。
	BeforeUninstall	Installers プロパティ内のインストーラのアンインストールが実行される前に発生します。
	Committed	Installers プロパティ内のすべてのインストーラがインストールをコミットした後で発生します。
	Committing	Installers プロパティ内のインストーラがインストールをコミットする前に発生します。
	Disposed	コンポーネントの Disposed イベントを待機するイベント ハンドラを追加します。(Component から継承されます。)

参照

関連項目

Installer クラス
System.Configuration.Install 名前空間
AssemblyInstaller クラス
ComponentInstaller クラス
InstallerCollection
TransactedInstaller

その他の技術情報

インストーラ ツール (Installutil.exe)