ServiceInstaller Class

定義

ServiceBase を拡張するクラスをインストールしてサービスを実装します。 Installs a class that extends ServiceBase to implement a service. このクラスは、サービス アプリケーションのインストール時に、インストール ユーティリティで呼び出されます。 This class is called by the install utility when installing a service application.

public class ServiceInstaller : System.Configuration.Install.ComponentInstaller
継承

次の例と呼ばれる、プロジェクト インストーラーを作成するMyProjectInstallerから継承されるInstallerします。The following example creates a project installer, called MyProjectInstaller, which inherits from Installer. 「Hello World サービス 1」2 つのサービスを含むサービス実行可能ファイルがあることが前提とし、"2" Hello World のサービス。It is assumed there is a service executable that contains two services, "Hello-World Service 1" and "Hello-World Service 2". コンス トラクター内でMyProjectInstaller(これが呼び出す、インストール ユーティリティで)、ServiceInstallerオブジェクトは、これらの各サービス、および作成ServiceProcessInstaller実行可能ファイルが作成されます。Within the constructor for MyProjectInstaller (which would be called by the install utility), ServiceInstaller objects are created for each of these services, and a ServiceProcessInstaller is created for the executable. インストール ユーティリティが認識するMyProjectInstallerとして有効なインストーラー、RunInstallerAttribute属性に設定されてtrueします。For the install utility to recognize MyProjectInstaller as a valid installer, the RunInstallerAttribute attribute is set to true.

インストーラーに追加する前に、プロセスのインストーラーおよびサービスのインストーラーで省略可能なプロパティが設定されて、Installersコレクション。Optional properties are set on the process installer and the service installers before the installers are added to the Installers collection. インストール ユーティリティにアクセスするときにMyProjectInstallerに追加されたオブジェクト、Installersを呼び出すことによってコレクションInstallerCollection.Add順番でインストールされています。When the install utility accesses MyProjectInstaller, the objects added to the Installers collection through a call to InstallerCollection.Add will be installed in turn. 処理中には、インストーラーは、オブジェクトがインストールされているため、それぞれのバックアップさらに、インストール エラーが発生した場合を示す状態情報を保持します。During the process, the installer maintains state information indicating which objects have been installed, so each can be backed out in turn, if an installation failure occurs.

通常、プロジェクト インストーラー クラスのインスタンスを明示的に作成するはできません。Normally, you would not create an instance of your project installer class explicitly. 作成し、追加し、は、RunInstallerAttribute属性の構文を実際に呼び出すし、そのためインスタンス化のクラスをインストール ユーティリティが。You would create it and add the RunInstallerAttribute attribute to the syntax, but it is the install utility that actually calls, and therefore instantiates, the class.

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

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

[RunInstaller(true)]
public ref class MyProjectInstaller : public Installer
{
private:
    ServiceInstaller^ serviceInstaller1;
    ServiceInstaller^ serviceInstaller2;
    ServiceProcessInstaller^ processInstaller;

public:
    MyProjectInstaller()
    {
        // Instantiate installers for process and services.
        processInstaller = gcnew ServiceProcessInstaller;
        serviceInstaller1 = gcnew ServiceInstaller;
        serviceInstaller2 = gcnew ServiceInstaller;

        // The services run under the system account.
        processInstaller->Account = ServiceAccount::LocalSystem;

        // The services are started manually.
        serviceInstaller1->StartType = ServiceStartMode::Manual;
        serviceInstaller2->StartType = ServiceStartMode::Manual;

        // ServiceName must equal those on ServiceBase derived classes.
        serviceInstaller1->ServiceName = "Hello-World Service 1";
        serviceInstaller2->ServiceName = "Hello-World Service 2";

        // Add installers to collection. Order is not important.
        Installers->Add( serviceInstaller1 );
        Installers->Add( serviceInstaller2 );
        Installers->Add( processInstaller );
    }

    static void Main()
    {
        Console::WriteLine("Usage: InstallUtil.exe [<service>.exe]");
    }
};

int main()
{
    MyProjectInstaller::Main();
}
using System;
using System.Collections;
using System.Configuration.Install;
using System.ServiceProcess;
using System.ComponentModel;

[RunInstaller(true)]
public class MyProjectInstaller : Installer
{
    private ServiceInstaller serviceInstaller1;
    private ServiceInstaller serviceInstaller2;
    private ServiceProcessInstaller processInstaller;

    public MyProjectInstaller()
    {
        // Instantiate installers for process and services.
        processInstaller = new ServiceProcessInstaller();
        serviceInstaller1 = new ServiceInstaller();
        serviceInstaller2 = new ServiceInstaller();

        // The services run under the system account.
        processInstaller.Account = ServiceAccount.LocalSystem;

        // The services are started manually.
        serviceInstaller1.StartType = ServiceStartMode.Manual;
        serviceInstaller2.StartType = ServiceStartMode.Manual;

        // ServiceName must equal those on ServiceBase derived classes.
        serviceInstaller1.ServiceName = "Hello-World Service 1";
        serviceInstaller2.ServiceName = "Hello-World Service 2";

        // Add installers to collection. Order is not important.
        Installers.Add(serviceInstaller1);
        Installers.Add(serviceInstaller2);
        Installers.Add(processInstaller);
    }

    public static void Main()
    {
        Console.WriteLine("Usage: InstallUtil.exe [<service>.exe]");
    }
}

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

<RunInstallerAttribute(True)> _
Public Class MyProjectInstaller
    Inherits Installer
    Private serviceInstaller1 As ServiceInstaller
    Private serviceInstaller2 As ServiceInstaller
    Private processInstaller As ServiceProcessInstaller    
    
    Public Sub New()
        ' Instantiate installers for process and services.
        processInstaller = New ServiceProcessInstaller()
        serviceInstaller1 = New ServiceInstaller()
        serviceInstaller2 = New ServiceInstaller()
        
        ' The services will run under the system account.
        processInstaller.Account = ServiceAccount.LocalSystem
        
        ' The services will be started manually.
        serviceInstaller1.StartType = ServiceStartMode.Manual
        serviceInstaller2.StartType = ServiceStartMode.Manual
        
        ' ServiceName must equal those on ServiceBase derived classes.            
        serviceInstaller1.ServiceName = "Hello-World Service 1"
        serviceInstaller2.ServiceName = "Hello-World Service 2"
        
        ' Add installers to collection. Order is not important.
        Installers.Add(serviceInstaller1)
        Installers.Add(serviceInstaller2)
        Installers.Add(processInstaller)
    End Sub

    Public Shared Sub Main()
        Console.WriteLine("Usage: InstallUtil.exe [<service>.exe]")
    End Sub
End Class

注釈

ServiceInstaller関連付けられているサービスに固有の機能です。The ServiceInstaller does work specific to the service with which it is associated. Hkey_local_machine \system\currentcontrolset\services レジストリ キーのサブキーをサービスに関連付けられたレジストリ値を書き込むため、インストール ユーティリティによって使用されます。It is used by the installation utility to write registry values associated with the service to a subkey within the HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services registry key. サービスは、このサブキー内で識別されます。The service is identified by its ServiceName within this subkey. サブキーには、実行可能ファイルまたはサービスが属する .dll の名前も含まれています。The subkey also includes the name of the executable or .dll to which the service belongs.

継承されるプロジェクト インストーラー クラスを作成、サービスをインストールする、Installerクラスし、設定、RunInstallerAttribute属性をクラスtrueします。To install a service, create a project installer class that inherits from the Installer class, and set the RunInstallerAttribute attribute on the class to true. プロジェクト内で 1 つ作成ServiceProcessInstallerサービス アプリケーション、および 1 つごとにインスタンスServiceInstallerアプリケーション内の各サービスのインスタンス。Within your project, create one ServiceProcessInstaller instance per service application, and one ServiceInstaller instance for each service in the application. クラスのコンス トラクター、プロジェクト インストーラー内でサービスを使用して、インストールのプロパティを設定、ServiceProcessInstallerServiceInstallerインスタンス、およびインスタンスの追加、Installersコレクション。Within your project installer class constructor, set the installation properties for the service using the ServiceProcessInstaller and ServiceInstaller instances, and add the instances to the Installers collection.

注意

インストーラーのインスタンスを追加するため、コンス トラクターを使用することをお勧めただしに追加する必要がある場合、Installers内のコレクション、Installメソッドで、コレクションに同じ追加機能を実行してください、Uninstallメソッド。It is recommended that you use the constructor for adding installer instances; however, if you need to add to the Installers collection in the Install method, be sure to perform the same additions to the collection in the Uninstall method.

すべてのクラスから派生する、Installerクラスの状態、Installersコレクションが同じである必要があります、InstallUninstallメソッド。For all classes deriving from the Installer class, the state of the Installers collection must be the same in the Install and Uninstall methods. ただし、全体でコレクションのメンテナンスを回避できます、InstallUninstallメソッドにインストーラーのインスタンスを追加する場合、Installersカスタム インストーラー クラスのコンス トラクター内のコレクション。インストール ユーティリティが呼び出されると、検索、RunInstallerAttribute属性。However, you can avoid the maintenance of the collection across the Install and Uninstall methods if you add installer instances to the Installers collection in your custom installer class constructor.When the install utility is called, it looks for the RunInstallerAttribute attribute. 属性がある場合true、ユーティリティに追加されたすべてのサービスのインストール、Installersプロジェクト インストーラーに関連付けられているコレクション。If the attribute is true, the utility installs all the services that were added to the Installers collection that were associated with your project installer. 場合RunInstallerAttributefalseか、存在しないか、インストール ユーティリティ プロジェクト インストーラーは無視されます。If RunInstallerAttribute is false or does not exist, the install utility ignores the project installer.

ServiceProcessInstaller情報に関連付けられた、プロジェクトのインストール クラス インストールすべてに共通するServiceInstallerプロジェクト内のインスタンス。The ServiceProcessInstaller associated with your project installation class installs information common to all ServiceInstaller instances in the project. このサービスが何もインストール プロジェクトの他のサービスから分離する場合、そのサービスに固有の情報は、このメソッドによってインストールされます。If this service has anything that separates it from the other services in the installation project, that service-specific information is installed by this method.

注意

重要ですが、ServiceNameと同じで、ServiceBase.ServiceNameから派生したクラスのServiceBaseします。It is crucial that the ServiceName be identical to the ServiceBase.ServiceName of the class you derived from ServiceBase. 値では、通常、ServiceBase.ServiceNameサービス アプリケーションの実行可能ファイルの Main() 関数内で、サービスのプロパティが設定されています。Normally, the value of the ServiceBase.ServiceName property for the service is set within the Main() function of the service application's executable. サービス コントロール マネージャーを使用して、ServiceInstaller.ServiceNameプロパティをこの実行可能ファイル内でサービスを見つけます。The Service Control Manager uses the ServiceInstaller.ServiceName property to locate the service within this executable.

その他のプロパティを変更することができます、ServiceInstaller前に、または後に追加すること、Installersプロジェクト インストーラーのコレクション。You can modify other properties on the ServiceInstaller either before or after adding it to the Installers collection of your project installer. たとえば、サービスのStartTypeの再起動時に自動的にサービスを開始または、ユーザー、サービスを手動で開始する必要がありますに設定することがあります。For example, a service's StartType may be set to start the service automatically at reboot or require a user to start the service manually.

通常がないメソッドを呼び出す、ServiceInstallerは、コード内で一般的に呼び出される、インストール ユーティリティでのみです。Normally, you will not call the methods on ServiceInstaller within your code; they are generally called only by the install utility. インストール ユーティリティが自動的に呼び出し、ServiceProcessInstaller.InstallServiceInstaller.Installインストール プロセス中にメソッド。The install utility automatically calls the ServiceProcessInstaller.Install and ServiceInstaller.Install methods during the installation process. バックアップ実行の障害を必要に応じて、呼び出すことによってRollback(またはServiceInstaller.Rollback) は以前にインストールされたすべてのコンポーネント。It backs out failures, if necessary, by calling Rollback (or ServiceInstaller.Rollback) on all previously installed components.

インストール ユーティリティ呼び出しUninstallオブジェクトを削除します。The installation utility calls Uninstall to remove the object.

アプリケーションのインストールが自動的にプロジェクトのインストーラーを使用して、既にインストールされているコンポーネントに関する情報を保持Installer.Contextします。An application's install routine maintains information automatically about the components already installed, using the project installer's Installer.Context. この状態情報は継続的に更新、ServiceProcessInstallerインスタンス、および各ServiceInstallerユーティリティによってインスタンスがインストールされています。This state information is continuously updated as the ServiceProcessInstaller instance, and each ServiceInstaller instance is installed by the utility. 状態情報を明示的に変更するコードを通常必要はありません。It is usually unnecessary for your code to modify state information explicitly.

自動的に作成し、インストールを実行するときに、EventLogInstallerに関連付けられているイベント ログ ソースをインストールする、ServiceBaseクラスを派生します。When the installation is performed, it automatically creates an EventLogInstaller to install the event log source associated with the ServiceBase derived class. Logこのソースのプロパティが設定されて、ServiceInstallerコンピューターのアプリケーション ログにコンス トラクター。The Log property for this source is set by the ServiceInstaller constructor to the computer's Application log. 設定すると、ServiceNameServiceInstaller(と同じにする必要があります、ServiceBase.ServiceNameサービスの)、Sourceは自動的に同じ値に設定します。When you set the ServiceName of the ServiceInstaller (which should be identical to the ServiceBase.ServiceName of the service), the Source is automatically set to the same value. インストール エラーのソースのインストールが以前にインストールされているサービスとは、ロールバックされます。In an installation failure, the source's installation is rolled-back along with previously installed services.

Uninstallメソッドが実行されている場合、サービスを停止しようとしました。The Uninstall method tries to stop the service if it is running. または、これが成功するかどうかUninstallによって行われた変更を元に戻しますInstallします。Whether this succeeds or not, Uninstall undoes the changes made by Install. イベントのログ記録を新しいソースを作成した場合、ソースが削除されます。If a new source was created for event logging, the source is deleted.

コンストラクター

ServiceInstaller()

ServiceInstaller クラスの新しいインスタンスを初期化します。 Initializes a new instance of the ServiceInstaller class.

プロパティ

CanRaiseEvents

コンポーネントがイベントを発生させることがきるかどうかを示す値を取得します。 Gets a value indicating whether the component can raise an event.

(Inherited from Component)
Container

IContainer を格納している Component を取得します。 Gets the IContainer that contains the Component.

(Inherited from Component)
Context

現在のインストールに関する情報を取得または設定します。 Gets or sets information about the current installation.

(Inherited from Installer)
DelayedAutoStart

他の自動的に開始されるサービスが実行されるまでサービスの開始を遅延するかどうかを示す値を取得または設定します。 Gets or sets a value that indicates whether the service should be delayed from starting until other automatically started services are running.

Description

サービスの説明を取得または設定します。 Gets or sets the description for the service.

DesignMode

Component が現在デザイン モードかどうかを示す値を取得します。 Gets a value that indicates whether the Component is currently in design mode.

(Inherited from Component)
DisplayName

ユーザーがサービスを識別するための表示名を示します。 Indicates the friendly name that identifies the service to the user.

Events

Component に結び付けられているイベント ハンドラーのリストを取得します。 Gets the list of event handlers that are attached to this Component.

(Inherited from Component)
HelpText

インストーラー コレクション内のすべてのインストーラーに関するヘルプ テキストを取得します。 Gets the help text for all the installers in the installer collection.

(Inherited from Installer)
Installers

インストーラーが格納しているインストーラーのコレクションを取得します。 Gets the collection of installers that this installer contains.

(Inherited from Installer)
Parent

インストーラーが属しているコレクションを格納しているインストーラーを取得または設定します。 Gets or sets the installer containing the collection that this installer belongs to.

(Inherited from Installer)
ServiceName

このサービスを識別するためにシステムが使用する名前を示します。 Indicates the name used by the system to identify this service. このプロパティは、インストールするサービスの ServiceName と同じにする必要があります。 This property must be identical to the ServiceName of the service you want to install.

ServicesDependedOn

このサービスを実行するために実行する必要があるサービスを示します。 Indicates the services that must be running for this service to run.

Site

ComponentISite を取得または設定します。 Gets or sets the ISite of the Component.

(Inherited from Component)
StartType

このサービスがいつ、どのように開始されるかを示します。 Indicates how and when this service is started.

方法

Commit(IDictionary)

派生クラスによってオーバーライドされた場合、インストール トランザクションを完了します。 When overridden in a derived class, completes the install transaction.

(Inherited from Installer)
CopyFromComponent(IComponent)

プロパティを ServiceBase のインスタンスからこのインストーラーへコピーします。 Copies properties from an instance of ServiceBase to this installer.

CreateObjRef(Type)

リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。 Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Inherited from MarshalByRefObject)
Dispose()

Component によって使用されているすべてのリソースを解放します。 Releases all resources used by the Component.

(Inherited from Component)
Dispose(Boolean)

Component によって使用されているアンマネージド リソースを解放し、オプションでマネージド リソースも解放します。 Releases the unmanaged resources used by the Component and optionally releases the managed resources.

(Inherited from Component)
Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。 Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

既定のハッシュ関数として機能します。 Serves as the default hash function.

(Inherited from Object)
GetLifetimeService()

対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービス オブジェクトを取得します。 Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
GetService(Type)

Component またはその Container で提供されるサービスを表すオブジェクトを返します。 Returns an object that represents a service provided by the Component or by its Container.

(Inherited from Component)
GetType()

現在のインスタンスの Type を取得します。 Gets the Type of the current instance.

(Inherited from Object)
InitializeLifetimeService()

このインスタンスの有効期間ポリシーを制御する有効期間サービス オブジェクトを取得します。 Obtains a lifetime service object to control the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
Install(IDictionary)

サービス アプリケーション情報をレジストリに書き込んで、サービスをインストールします。 Installs the service by writing service application information to the registry. このメソッドは、セットアップ ツールで使用されます。セットアップ ツールは適切なメソッドを自動的に処理します。 This method is meant to be used by installation tools, which process the appropriate methods automatically.

IsEquivalentInstaller(ComponentInstaller)

2 つのインストーラーが同じサービスをインストールするかどうかを示します。 Indicates whether two installers would install the same service.

MemberwiseClone()

現在の Object の簡易コピーを作成します。 Creates a shallow copy of the current Object.

(Inherited from Object)
MemberwiseClone(Boolean)

現在の MarshalByRefObject オブジェクトの簡易コピーを作成します。 Creates a shallow copy of the current MarshalByRefObject object.

(Inherited from MarshalByRefObject)
OnAfterInstall(IDictionary)

AfterInstall イベントを発生させます。 Raises the AfterInstall event.

(Inherited from Installer)
OnAfterRollback(IDictionary)

AfterRollback イベントを発生させます。 Raises the AfterRollback event.

(Inherited from Installer)
OnAfterUninstall(IDictionary)

AfterUninstall イベントを発生させます。 Raises the AfterUninstall event.

(Inherited from Installer)
OnBeforeInstall(IDictionary)

BeforeInstall イベントを発生させます。 Raises the BeforeInstall event.

(Inherited from Installer)
OnBeforeRollback(IDictionary)

BeforeRollback イベントを発生させます。 Raises the BeforeRollback event.

(Inherited from Installer)
OnBeforeUninstall(IDictionary)

BeforeUninstall イベントを発生させます。 Raises the BeforeUninstall event.

(Inherited from Installer)
OnCommitted(IDictionary)

Committed イベントを発生させます。 Raises the Committed event.

(Inherited from Installer)
OnCommitting(IDictionary)

Committing イベントを発生させます。 Raises the Committing event.

(Inherited from Installer)
Rollback(IDictionary)

インストール プロシージャによってレジストリに書き込まれたサービス アプリケーション情報をロールバックします。 Rolls back service application information written to the registry by the installation procedure. このメソッドは、セットアップ ツールで使用されます。セットアップ ツールは適切なメソッドを自動的に処理します。 This method is meant to be used by installation tools, which process the appropriate methods automatically.

ToString()

Component の名前 (存在する場合) を格納する String を返します。 Returns a String containing the name of the Component, if any. このメソッドはオーバーライドできません。 This method should not be overridden.

(Inherited from Component)
Uninstall(IDictionary)

サービスに関する情報をレジストリから削除して、サービスをアンインストールします。 Uninstalls the service by removing information about it from the registry.

イベント

AfterInstall

Installers プロパティ内のすべてのインストーラーの Install(IDictionary) メソッドが実行された後で発生します。 Occurs after the Install(IDictionary) methods of all the installers in the Installers property have run.

(Inherited from Installer)
AfterRollback

Installers プロパティ内のすべてのインストーラーによるインストールがロールバックされた後で発生します。 Occurs after the installations of all the installers in the Installers property are rolled back.

(Inherited from Installer)
AfterUninstall

Installers プロパティ内のすべてのインストーラーのアンインストールが実行された後で発生します。 Occurs after all the installers in the Installers property perform their uninstallation operations.

(Inherited from Installer)
BeforeInstall

インストーラー コレクション内の各インストーラーの Install(IDictionary) メソッドが実行される前に発生します。 Occurs before the Install(IDictionary) method of each installer in the installer collection has run.

(Inherited from Installer)
BeforeRollback

Installers プロパティ内のインストーラーがロールバックされる前に発生します。 Occurs before the installers in the Installers property are rolled back.

(Inherited from Installer)
BeforeUninstall

Installers プロパティ内のインストーラーのアンインストールが実行される前に発生します。 Occurs before the installers in the Installers property perform their uninstall operations.

(Inherited from Installer)
Committed

Installers プロパティ内のすべてのインストーラーがインストールをコミットした後で発生します。 Occurs after all the installers in the Installers property have committed their installations.

(Inherited from Installer)
Committing

Installers プロパティ内のインストーラーがインストールをコミットする前に発生します。 Occurs before the installers in the Installers property committ their installations.

(Inherited from Installer)
Disposed

Dispose() メソッドの呼び出しによってコンポーネントが破棄されると発生します。 Occurs when the component is disposed by a call to the Dispose() method.

(Inherited from Component)

適用対象

こちらもご覧ください