Export (0) Print
Expand All

Walkthrough: Creating a Windows Service Application in the Component Designer

Visual Studio .NET 2003
Note   The Windows Service template and associated functionality is not available in the Standard Edition of Visual Basic and Visual C# .NET. For more information, see Visual Basic Standard Edition Features or Visual C# Standard Edition Features.

The procedures in this topic walk you through the process of creating a simple Windows Service application that writes messages to an event log. The basic steps that you perform to create and use your service include:

  • Create a project using the Windows Service application template. This template creates a class for you that inherits from ServiceBase and writes much of the basic service code, such as the code to start the service.
  • Write the code for the OnStart and OnStop procedures, and override any other methods that you want to redefine.
  • Add the necessary installers for your service application. By default, a class containing two or more installers is added to your application when you click the Add Installer link: one to install the process, and one for each of the associated services your project contains.
  • Build your project.
  • Create a setup project to install your service, and then install it.
  • Access the Windows 2000 Services Control Manager and start your service.

To begin with, you create the project and set values that are necessary for the service to function correctly.

To create and configure your service

  1. On the File menu, point to New, and then click Project.

    The New Project dialog box opens.

  2. Select the Windows Service project from the list of Visual Basic or Visual C# project templates, and name it MyNewService.
    Note   The project template automatically adds a component class called Service1 that inherits from System.ServiceProcess.ServiceBase.
  3. Click the designer to select Service1. Then, in the Properties window, set the ServiceName property for Service1 to MyNewService.
  4. Set the AutoLog property to true.
  5. On the View menu, choose Code to open the Code Editor. Edit the Main method to create an instance of MyNewService. When you renamed the service in step 3, the class name was not modified in the Main method. To access the Main method in Visual Basic, expand the Component Designer generated code region.
    ' Visual Basic
    Shared Sub Main()
       Dim ServicesToRun() As System.ServiceProcess.ServiceBase
       ' Change the following line to match.
       ServicesToRun = New System.ServiceProcess.ServiceBase() _
          {New MyNewService()}
       System.ServiceProcess.ServiceBase.Run(ServicesToRun)
    End Sub
    
    // C#
    static void Main()
    {
       System.ServiceProcess.ServiceBase[] ServicesToRun;
       // Change the following line to match.
       ServicesToRun = new System.ServiceProcess.ServiceBase[] 
          { new MyNewService() };
       System.ServiceProcess.ServiceBase.Run(ServicesToRun);
    }
    

In the next section, you will add a custom event log to your Windows service. Event logs are not associated in any way with Windows services. Here the EventLog component is used as an example of the type of components you could add to a Windows service. For more information on custom event logs, see Creating and Removing Custom Event Logs.

To add custom event log functionality to your service

  1. In the Solution Explorer, right-click Service1.vb or Service1.cs and select View Designer.
  2. From the Components tab of the Toolbox, drag an EventLog component to the designer.
  3. In the Solution Explorer, right-click Service1.vb or Service1.cs and select View Code.
  4. Edit the constructor to define a custom event log. To access the constructor in Visual Basic, expand the Component Designer generated code region.
    ' Visual Basic
    Public Sub New()
       MyBase.New
       InitializeComponent()
       If Not EventLog.SourceExists("MySource") Then
          EventLog.CreateEventSource("MySource", "MyNewLog")
       End If
       EventLog1.Source = "MySource"
       EventLog1.Log = "MyNewLog"
    End Sub
    
    // C#
    public MyNewService()
    {
       InitializeComponent();
       if (!System.Diagnostics.EventLog.SourceExists("MySource")) 
       {         
          System.Diagnostics.EventLog.CreateEventSource(
             "MySource","MyNewLog");
       }
       eventLog1.Source = "MySource";
       eventLog1.Log = "MyNewLog";
    }
    

To define what happens when the service starts

  • In the Code Editor, locate the OnStart method that was automatically overridden when you created the project, and write code to determine what occurs when the service begins running:
    ' Visual Basic
    Protected Overrides Sub OnStart(ByVal args() As String)
       EventLog1.WriteEntry("In OnStart")
    End Sub
    
    // C#
    protected override void OnStart(string[] args)
    {
       eventLog1.WriteEntry("In OnStart");
    }
    
    Note   A service application is designed to be long running. As such, it usually polls or monitors something in the system. The monitoring is set up in the OnStart method. However, OnStart does not actually do the monitoring. The OnStart method must return to the operating system once the service's operation has begun. It must not loop forever or block. To set up a simple polling mechanism, you can use the System.Timers.Timer component. In the OnStart method, you would set parameters on the component, and then you would set the Timer.Enabled property to true. The timer would then raise events in your code periodically, at which time your service could do its monitoring.

To define what happens when the service is stopped

  • In the Code Editor, locate the OnStop procedure that was automatically overridden when you created the project, and write code to determine what occurs when the service is stopped:
    ' Visual Basic
    Protected Overrides Sub OnStop()
       EventLog1.WriteEntry("In OnStop.")
    End Sub
    
    // C#
    protected override void OnStop()
    {
       eventLog1.WriteEntry("In onStop."); 
    }
    

You can also override the OnPause, OnContinue, and OnShutdown methods to define further processing for your component.

To define other actions for the service

  • For the method you want to handle, override the appropriate method and define what you want to occur.

    The following code shows what it looks like if you override the OnContinue method:

    ' Visual Basic
    Protected Overrides Sub OnContinue()
       EventLog1.WriteEntry("In OnContinue.")
    End Sub
    
    // C#
    protected override void OnContinue()
    {
       eventLog1.WriteEntry("In OnContinue.");
    }  
    

Some custom actions need to occur when installing a Windows service, which can be done by the Installer class. Visual Studio can create these installers specifically for a Windows service and add them to your project.

To create the installers for your service

  1. Return to Design view for Service1.
  2. Click the background of the designer to select the service itself, rather than any of its contents.
  3. In the Properties window, click the Add Installer link in the gray area beneath the list of properties.

    By default, a component class containing two installers is added to your project. The component is named ProjectInstaller, and the installers it contains are the installer for your service and the installer for the service's associated process.

  4. Access Design view for ProjectInstaller, and click ServiceInstaller1.
  5. In the Properties window, set the ServiceName property to MyNewService.
  6. Set the StartType property to Automatic.
  7. In the designer, select ServiceProcessInstaller1 (for a Visual Basic project), or serviceProcessInstaller1 (for a Visual C# project). Set the Account property to LocalService. This will cause the service to be installed and to run on a local service account. For more information, see ServiceProcessInstaller.Account Property.
    Security Note   The LocalService account acts as a non-privileged user on the local computer, and presents anonymous credentials to any remote server. Use the other accounts with caution, as they run with higher privileges and increase your risk of attacks from malicious code.

To build your service project

  1. In Solution Explorer, right-click your project and select Properties from the shortcut menu. The project's Property Pages dialog box appears.
  2. In the left pane, select the General tab in the Common Properties folder.
  3. From the Startup object list, choose MyNewService (for a Visual Basic project), or MyNewService.MyNewService (for a Visual C# project). Click OK.
  4. Press CTRL+SHIFT+B to build the project.

Now that the project is built, it can be deployed. A setup project will install the compiled project files and run the installers needed to run the Windows service. To create a complete setup project you will need to add the project output, MyNewService.exe, to the setup project and then add a custom action to have MyNewService.exe installed. For more information on setup projects, see Setup Projects. For more information on custom actions, see Walkthrough: Creating a Custom Action.

To create a setup project for your service

  1. On the File menu, point to Add Project, and then choose New Project.
  2. In the Project Types pane, select the Setup and Deployment Projects folder.
  3. In the Templates pane, select Setup Project. Name the project MyServiceSetup.

    A setup project is added to the solution.

Next you will add the output from the Windows Service project, MyNewService.exe, to the setup.

To add MyNewService.exe to the setup project

  1. In Solution Explorer, right-click MyServiceSetup, point to Add, then choose Project Output.

    The Add Project Output Group dialog box appears.

  2. MyNewService is selected in the Project box.
  3. From the list box, select Primary Output, and click OK.

    A project item for the primary output of MyNewService is added to the setup project. Now add a custom action to install the MyNewService.exe file.

To add a custom action to the setup project

  1. In Solution Explorer, right-click the setup project, point to View, then choose Custom Actions.

    The Custom Actions editor appears.

  2. In the Custom Actions editor, right-click the Custom Actions node and choose Add Custom Action.

    The Select Item in Project dialog box appears.

  3. Double-click the Application Folder in the list box to open it, select Primary Output from MyNewService (Active), and click OK.

    The primary output is added to all four nodes of the custom actions — Install, Commit, Rollback, and Uninstall.

  4. In Solution Explorer, right-click the MyServiceSetup project and choose Build.

To install the Windows Service

  • To install MyEventLog.exe, right-click the setup project in the Solution Explorer and select Install.

To start and stop your service

  1. Open the Services Control Manager by doing one of the following:
    • In Windows 2000 Professional, right-click My Computer on the desktop, then click Manage. In the Computer Management console, expand the Services and Applications node.

      - or -

    • In Windows 2000 Server, click Start, point to Programs, click Administrative Tools, and then click Services.
      Note   In Windows NT version 4.0, you can open this dialog box from Control Panel.

    You should now see MyNewService listed in the Services section of the window.

  2. Select your service in the list, right-click it, and then click Start.
  3. Right-click the service, and then click Stop.

To verify the event log output of your service

  1. Open Server Explorer and access the Event Logs node. For more information, see Working with Event Logs in Server Explorer.
    Note   The Servers node of Server Explorer is not available in the Standard Edition of Visual Basic and Visual C# .NET. For more information, see Visual Basic Standard Edition Features or Visual C# Standard Edition Features.
  2. Locate the listing for MyNewLog and expand it. You should see entries for the actions your service has performed.

To uninstall your service

  • On the Start menu, open Control Panel and click Add/Remove Programs, and then locate your service and click Uninstall.
  • You can also uninstall the program by right-clicking the program icon for the .msi file and selecting Uninstall.
    Note   If you installed the service on Windows 2000, you will need to reboot the system before you can reinstall the service. In Windows 2000, services are not completely deleted until the system is rebooted.

Next Steps

You might also explore the use of a ServiceController component to allow you to send commands to the service you have installed. For more information on using the ServiceController component, see Monitoring Windows Services.

You can use an installer to create an event log when the application is installed, rather than creating the event log when the application runs. Additionally, the event log will be deleted by the installer when the application is uninstalled. For more information, see Walkthrough: Installing an Event Log Component.

See Also

Windows Service Applications | Introduction to Windows Service Applications | Adding Installers to your Service Application | Installing and Uninstalling Services | Debugging Windows Service Applications | Launching Event Viewer | Accessing and Initializing Server Explorer

Show:
© 2014 Microsoft