ServiceProcessInstaller Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Installs an executable containing classes that extend ServiceBase. This class is called by installation utilities, such as InstallUtil.exe, when installing a service application.
public ref class ServiceProcessInstaller : System::Configuration::Install::ComponentInstallerpublic class ServiceProcessInstaller : System.Configuration.Install.ComponentInstallertype ServiceProcessInstaller = class
inherit ComponentInstallerPublic Class ServiceProcessInstaller
Inherits ComponentInstaller- Inheritance
Examples
The following example creates a project installer called MyProjectInstaller, which inherits from Installer. It is assumed there is a service executable that contains two services, "Hello-World Service 1" and "Hello-World Service 2". Within the constructor for MyProjectInstaller (which would be called by the install utility), ServiceInstaller objects are created for each service, and a ServiceProcessInstaller is created for the executable. For the install utility to recognize MyProjectInstaller as a valid installer, the RunInstallerAttribute attribute is set to true.
Optional properties are set on the process installer and the service installers before the installers are added to the Installers collection. 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 object can be backed out in turn in case of an installation failure.
Normally, you would not instantiate your project installer class explicitly. You would create it and add the RunInstallerAttribute, but the install utility 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.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
Remarks
The ServiceProcessInstaller does work common to all services in an executable. It is used by the installation utility to write registry values associated with services you want to install.
To install a service, create a project installer class that inherits from Installer, and set the RunInstallerAttribute on the class to true. Within your project, instantiate one ServiceProcessInstaller instance per service application, and one ServiceInstaller instance for each service in the application. Finally, add the ServiceProcessInstaller instance and the ServiceInstaller instances to your project installer class.
When InstallUtil.exe runs, the utility looks for classes in the service assembly with the RunInstallerAttribute set to true. Add classes to the service assembly by adding them to the Installers collection associated with your project installer. If RunInstallerAttribute is false, the install utility ignores the project installer.
For an instance of ServiceProcessInstaller, properties you can modify include specifying that a service application run under an account other than the logged-on user. You can specify a particular Username and Password pair under which the service should run, or you can use Account to specify that the service run under the computer's System account, a local or network service account, or a user account.
Note
The computer's System account is not the same as the Administrator account.
Normally, you do not call the methods on ServiceInstaller within your code; they are generally called only by the install utility. The install utility automatically calls the ServiceProcessInstaller.Install and ServiceInstaller.Install methods during the installation process. It backs out failures, if necessary, by calling Rollback (or ServiceInstaller.Rollback) on all previously installed components.
An application's install routine maintains information automatically about the components already installed, using the project installer's Installer.Context. 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 this state information explicitly.
Instantiating a ServiceProcessInstaller causes the base class constructor, ComponentInstaller, to be called.
Constructors
| ServiceProcessInstaller() |
Creates a new instance of the ServiceProcessInstaller class. |
Properties
| Account |
Gets or sets the type of account under which to run this service application. |
| CanRaiseEvents |
Gets a value indicating whether the component can raise an event. (Inherited from Component) |
| Container |
Gets the IContainer that contains the Component. (Inherited from Component) |
| Context |
Gets or sets information about the current installation. (Inherited from Installer) |
| DesignMode |
Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component) |
| Events |
Gets the list of event handlers that are attached to this Component. (Inherited from Component) |
| HelpText |
Gets help text displayed for service installation options. |
| 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) |
| Password |
Gets or sets the password associated with the user account under which the service application runs. |
| Site |
Gets or sets the ISite of the Component. (Inherited from Component) |
| Username |
Gets or sets the user account under which the service application will run. |
Methods
| Commit(IDictionary) |
When overridden in a derived class, completes the install transaction. (Inherited from Installer) |
| CopyFromComponent(IComponent) |
Implements the base class CopyFromComponent(IComponent) method with no ServiceProcessInstaller class-specific behavior. |
| 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() |
Releases all resources used by the Component. (Inherited from Component) |
| Dispose(Boolean) |
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() |
Obsolete.
Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| GetService(Type) |
Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| InitializeLifetimeService() |
Obsolete.
Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| Install(IDictionary) |
Writes service application information to the registry. This method is meant to be used by installation tools, which call the appropriate methods automatically. |
| IsEquivalentInstaller(ComponentInstaller) |
Determines if the specified installer installs the same object as this installer. (Inherited from ComponentInstaller) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| MemberwiseClone(Boolean) |
Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject) |
| OnAfterInstall(IDictionary) |
Raises the AfterInstall event. (Inherited from Installer) |
| OnAfterRollback(IDictionary) |
Raises the AfterRollback event. (Inherited from Installer) |
| OnAfterUninstall(IDictionary) |
Raises the AfterUninstall event. (Inherited from Installer) |
| OnBeforeInstall(IDictionary) |
Raises the BeforeInstall event. (Inherited from Installer) |
| OnBeforeRollback(IDictionary) |
Raises the BeforeRollback event. (Inherited from Installer) |
| OnBeforeUninstall(IDictionary) |
Raises the BeforeUninstall event. (Inherited from Installer) |
| OnCommitted(IDictionary) |
Raises the Committed event. (Inherited from Installer) |
| OnCommitting(IDictionary) |
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() |
Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component) |
| Uninstall(IDictionary) |
When overridden in a derived class, removes an installation. (Inherited from Installer) |
Events
| AfterInstall |
Occurs after the Install(IDictionary) methods of all the installers in the Installers property have run. (Inherited from Installer) |
| AfterRollback |
Occurs after the installations of all the installers in the Installers property are rolled back. (Inherited from Installer) |
| AfterUninstall |
Occurs after all the installers in the Installers property perform their uninstallation operations. (Inherited from Installer) |
| BeforeInstall |
Occurs before the Install(IDictionary) method of each installer in the installer collection has run. (Inherited from Installer) |
| BeforeRollback |
Occurs before the installers in the Installers property are rolled back. (Inherited from Installer) |
| BeforeUninstall |
Occurs before the installers in the Installers property perform their uninstall operations. (Inherited from Installer) |
| Committed |
Occurs after all the installers in the Installers property have committed their installations. (Inherited from Installer) |
| Committing |
Occurs before the installers in the Installers property commit their installations. (Inherited from Installer) |
| Disposed |
Occurs when the component is disposed by a call to the Dispose() method. (Inherited from Component) |
