ServiceInstaller クラス

  • リファレンス

定義

名前空間:
System.ServiceProcess
アセンブリ:
System.ServiceProcess.dll

ServiceBase を拡張するクラスをインストールしてサービスを実装します。 このクラスは、サービス アプリケーションのインストール時に、インストール ユーティリティで呼び出されます。

public ref class ServiceInstaller : System::Configuration::Install::ComponentInstaller
public class ServiceInstaller : System.Configuration.Install.ComponentInstaller
type ServiceInstaller = class
    inherit ComponentInstaller
Public Class ServiceInstaller
Inherits ComponentInstaller
継承
Object
MarshalByRefObject
Component
Installer
ComponentInstaller
ServiceInstaller

例

次の例では、 からInstaller継承する という名前MyProjectInstallerのプロジェクト インストーラーを作成します。 "Hello-World Service 1" と "Hello-World Service 2" の 2 つのサービスを含むサービス実行可能ファイルがあることを前提としています。 (インストール ユーティリティによって呼び出される) ServiceInstaller のMyProjectInstallerコンストラクター内で、これらのサービスごとに オブジェクトが作成されServiceProcessInstaller、実行可能ファイルに 対して が作成されます。 インストール ユーティリティが有効なインストーラーとして認識 MyProjectInstaller するには、 属性が RunInstallerAttribute に true設定されます。

オプションのプロパティは、インストーラーがコレクションに追加される前に、プロセス インストーラーとサービス インストーラーで Installers 設定されます。 インストール ユーティリティが にアクセスMyProjectInstallerすると、 の呼び出しInstallerCollection.AddによってコレクションにInstallers追加されたオブジェクトが順番にインストールされます。 このプロセス中、インストーラーは、インストールされているオブジェクトを示す状態情報を保持するため、インストールエラーが発生した場合は、それぞれを順番にバックアウトできます。

通常は、プロジェクト インストーラー クラスのインスタンスを明示的に作成しません。 これを作成し、 属性を RunInstallerAttribute 構文に追加しますが、 クラスを実際に呼び出してインスタンス化するのはインストール ユーティリティです。

#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.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 、関連付けられているサービスに固有の機能を実行します。 これは、サービスに関連付けられているレジストリ値を、HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services レジストリ キー内のサブキーに書き込む場合に、インストール ユーティリティによって使用されます。 サービスは、このサブキー内の ServiceName によって識別されます。 サブキーには、サービスが属する実行可能ファイルまたは.dllの名前も含まれます。

サービスをインストールするには、 クラスから継承するプロジェクト インストーラー クラスを Installer 作成し、 クラスの 属性を RunInstallerAttribute に true設定します。 プロジェクト内で、サービス アプリケーションごとに 1 つの ServiceProcessInstaller インスタンスを作成し、アプリケーション内のサービスごとに 1 つの ServiceInstaller インスタンスを作成します。 プロジェクト インストーラー クラス コンストラクター内で、 インスタンスと ServiceInstaller インスタンスを使用してサービスのインストール プロパティをServiceProcessInstaller設定し、インスタンスをコレクションにInstallers追加します。

注意

インストーラー インスタンスを追加する場合は、 コンストラクターを使用することをお勧めします。ただし、 メソッドの コレクションに を追加するInstallers必要がある場合は、 メソッド内InstallUninstallのコレクションに対して同じ追加を実行してください。

クラスからInstaller派生するすべてのクラスについて、コレクションの状態は Installers メソッドと Uninstall メソッドでInstall同じである必要があります。 ただし、カスタム インストーラー クラス コンストラクターのコレクションにインストーラー インスタンスを追加すると、 メソッドと Uninstall メソッド全体InstallでコレクションのInstallersメンテナンスを回避できます。インストール ユーティリティが呼び出されると、 属性が検索されますRunInstallerAttribute。 属性が の場合、 trueプロジェクト インストーラーに関連付けられたコレクションに Installers 追加されたすべてのサービスがユーティリティによってインストールされます。 が false または 存在しない場合RunInstallerAttribute、インストール ユーティリティはプロジェクト インストーラーを無視します。

プロジェクト インストール クラスに関連付けられている には ServiceProcessInstaller 、プロジェクト内のすべての ServiceInstaller インスタンスに共通する情報がインストールされます。 このサービスにインストール プロジェクト内の他のサービスとは別のサービスがある場合、そのサービス固有の情報はこのメソッドによってインストールされます。

注意

は、 からServiceBase派生したクラスの と同一ServiceBase.ServiceNameであることが重要ServiceNameです。 通常、サービスの プロパティの ServiceBase.ServiceName 値は、サービス アプリケーションの実行可能ファイルの Main() 関数内で設定されます。 サービス コントロール マネージャーは、 プロパティを ServiceInstaller.ServiceName 使用して、この実行可能ファイル内のサービスを検索します。

プロジェクト インストーラーのコレクションに追加する ServiceInstaller 前または後に、 Installers の他のプロパティを変更できます。 たとえば、再起動時にサービスを自動的に開始するようにサービスを StartType 設定したり、ユーザーにサービスを手動で開始させる必要がある場合があります。

通常、コード内で メソッド ServiceInstaller を呼び出すわけではありません。通常、これらはインストール ユーティリティによってのみ呼び出されます。 インストール ユーティリティは、インストール プロセス中に ServiceProcessInstaller.Install メソッドと ServiceInstaller.Install メソッドを自動的に呼び出します。 必要に応じて、以前にインストールされたすべてのコンポーネントで (または ServiceInstaller.Rollback) を呼び出Rollbackして、エラーをバックアウトします。

インストール ユーティリティは、 を呼び出 Uninstall して オブジェクトを削除します。

アプリケーションのインストール ルーチンでは、プロジェクト インストーラーの を使用して、既にインストールされているコンポーネントに関する情報が Installer.Context自動的に保持されます。 この状態情報はインスタンスとして ServiceProcessInstaller 継続的に更新され、各 ServiceInstaller インスタンスはユーティリティによってインストールされます。 通常、コードで状態情報を明示的に変更する必要があります。

インストールが実行されると、 が自動的に作成 EventLogInstaller され、派生クラスに関連付けられているイベント ログ ソースが ServiceBase インストールされます。 このソースの プロパティは Log 、コンストラクターによって ServiceInstaller コンピューターのアプリケーション ログに設定されます。 の を ServiceName 設定すると (サービスの ServiceInstaller と同じである ServiceBase.ServiceName 必要があります) Source 、 は自動的に同じ値に設定されます。 インストールエラーでは、ソースのインストールは、以前にインストールされたサービスと共にロールバックされます。

メソッドは Uninstall 、サービスが実行されている場合にサービスの停止を試みます。 これが成功したかどうかに関係なく、 Uninstall によって Install行われた変更を元に戻します。 イベント ログ用に新しいソースが作成された場合、ソースは削除されます。

コンストラクター

ServiceInstaller()

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

プロパティ

CanRaiseEvents

コンポーネントがイベントを発生させることがきるかどうかを示す値を取得します。

(継承元 Component)
Container

IContainer を含む Component を取得します。

(継承元 Component)
Context

現在のインストールに関する情報を取得または設定します。

(継承元 Installer)
DelayedAutoStart

他の自動的に開始されるサービスが実行されるまでサービスの開始を遅延するかどうかを示す値を取得または設定します。
Description

サービスの説明を取得または設定します。
DesignMode

Component が現在デザイン モードかどうかを示す値を取得します。

(継承元 Component)
DisplayName

ユーザーがサービスを識別するための表示名を示します。
Events

Component に結び付けられているイベント ハンドラーのリストを取得します。

(継承元 Component)
HelpText

インストーラー コレクション内のすべてのインストーラーに関するヘルプ テキストを取得します。

(継承元 Installer)
Installers

インストーラーが格納しているインストーラーのコレクションを取得します。

(継承元 Installer)
Parent

インストーラーが属しているコレクションを格納しているインストーラーを取得または設定します。

(継承元 Installer)
ServiceName

このサービスを識別するためにシステムが使用する名前を示します。 このプロパティは、インストールするサービスの ServiceName と同じにする必要があります。
ServicesDependedOn

このサービスを実行するために実行する必要があるサービスを示します。
Site

Component の ISite を取得または設定します。

(継承元 Component)
StartType

このサービスがいつ、どのように開始されるかを示します。

メソッド

Commit(IDictionary)

派生クラスによってオーバーライドされた場合、インストール トランザクションを完了します。

(継承元 Installer)
CopyFromComponent(IComponent)

プロパティを ServiceBase のインスタンスからこのインストーラーへコピーします。
CreateObjRef(Type)

リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。

(継承元 MarshalByRefObject)
Dispose()

Component によって使用されているすべてのリソースを解放します。

(継承元 Component)
Dispose(Boolean)

Component によって使用されているアンマネージド リソースを解放し、オプションでマネージド リソースも解放します。

(継承元 Component)
Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetLifetimeService()
古い.

対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービス オブジェクトを取得します。

(継承元 MarshalByRefObject)
GetService(Type)

Component またはその Container で提供されるサービスを表すオブジェクトを返します。

(継承元 Component)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
InitializeLifetimeService()
古い.

このインスタンスの有効期間ポリシーを制御する有効期間サービス オブジェクトを取得します。

(継承元 MarshalByRefObject)
Install(IDictionary)

サービス アプリケーション情報をレジストリに書き込んで、サービスをインストールします。 このメソッドは、セットアップ ツールで使用されます。セットアップ ツールは適切なメソッドを自動的に処理します。
IsEquivalentInstaller(ComponentInstaller)

2 つのインストーラーが同じサービスをインストールするかどうかを示します。
MemberwiseClone()

現在の Object の簡易コピーを作成します。

(継承元 Object)
MemberwiseClone(Boolean)

現在の MarshalByRefObject オブジェクトの簡易コピーを作成します。

(継承元 MarshalByRefObject)
OnAfterInstall(IDictionary)

AfterInstall イベントを発生させます。

(継承元 Installer)
OnAfterRollback(IDictionary)

AfterRollback イベントを発生させます。

(継承元 Installer)
OnAfterUninstall(IDictionary)

AfterUninstall イベントを発生させます。

(継承元 Installer)
OnBeforeInstall(IDictionary)

BeforeInstall イベントを発生させます。

(継承元 Installer)
OnBeforeRollback(IDictionary)

BeforeRollback イベントを発生させます。

(継承元 Installer)
OnBeforeUninstall(IDictionary)

BeforeUninstall イベントを発生させます。

(継承元 Installer)
OnCommitted(IDictionary)

Committed イベントを発生させます。

(継承元 Installer)
OnCommitting(IDictionary)

Committing イベントを発生させます。

(継承元 Installer)
Rollback(IDictionary)

インストール プロシージャによってレジストリに書き込まれたサービス アプリケーション情報をロールバックします。 このメソッドは、セットアップ ツールで使用されます。セットアップ ツールは適切なメソッドを自動的に処理します。
ToString()

Component の名前 (存在する場合) を格納する String を返します。 このメソッドはオーバーライドできません。

(継承元 Component)
Uninstall(IDictionary)

サービスに関する情報をレジストリから削除して、サービスをアンインストールします。

イベント

AfterInstall

Installers プロパティ内のすべてのインストーラーの Install(IDictionary) メソッドが実行された後で発生します。

(継承元 Installer)
AfterRollback

Installers プロパティ内のすべてのインストーラーによるインストールがロールバックされた後で発生します。

(継承元 Installer)
AfterUninstall

Installers プロパティ内のすべてのインストーラーのアンインストールが実行された後で発生します。

(継承元 Installer)
BeforeInstall

インストーラー コレクション内の各インストーラーの Install(IDictionary) メソッドが実行される前に発生します。

(継承元 Installer)
BeforeRollback

Installers プロパティ内のインストーラーがロールバックされる前に発生します。

(継承元 Installer)
BeforeUninstall

Installers プロパティ内のインストーラーのアンインストールが実行される前に発生します。

(継承元 Installer)
Committed

Installers プロパティ内のすべてのインストーラーがインストールをコミットした後で発生します。

(継承元 Installer)
Committing

Installers プロパティ内のインストーラーがインストールをコミットする前に発生します。

(継承元 Installer)
Disposed

Dispose() メソッドの呼び出しによってコンポーネントが破棄されるときに発生します。

(継承元 Component)

適用対象

こちらもご覧ください