Easiest language for creating a Windows service

windows-services

What is the easiest language to build Windows services in?

Easiest in this case would be defined as least amount of code, and lowest point of entry into the language.

Best Solution

At the risk of stating the obvious, if you have any C/C++/Java background, I think C# offers you the lowest point of entry.

Assuming you're using Visual Studio 2008, you can follow these steps:

  1. Open Visual Studio 2008, and select the File|New|Project menu option.
  2. In the New Project dialog...
    • Select the Visual C#|Windows node in Project types
    • Select the Windows Service template
    • Enter a name and location for your project
    • Press OK
  3. At this point, you have all the basics for your Windows service. The Program.cs file contains the Main() method for your service, and Service1.cs defines the System.ServiceProcess.ServiceBase component that is your new Windows service.
  4. In the Property Grid for your Service1 component, consider setting the following properties at a minimum:
    • (Name) - give your object an intuitive name, e.g., ServiceExample
    • AutoLog - set to false to prevent events from being written by default to the Application event log (Note: I'm not saying you shouldn't log service events; I just prefer writing to my own event log instead of the Application log - see below)
    • CanShutdown - set to true if you want to handle system shutdowns
    • ServiceName - defines the name by which your service will be known to the Service Control Manager (SCM)
  5. In the code for ServiceExample, the OnStart() and OnStop() virtual functions are stubbed out. You'll need to fill these in with whatever your service needs to do obviously. If you changed the CanShutdown property to true, you'll want to override the OnShutdown method as well. I've created an example below illustrating the use of these functions.
  6. At this point, the ServiceExample service is essentially complete, but you still need a way to install it. To do this, open the ServiceExample component in the designer. Right-click anywhere in the designer panel, and select the Add Installer menu option. This adds a ProjectInstaller component to your project, which contains two additional components - serviceProcessInstaller1 and serviceInstaller1.
  7. Select the serviceProcessInstaller1 component in the designer. In the Property Grid, consider setting the following properties:
    • (Name) - give your object an intuitive name, e.g., serviceProcessInstaller
    • Account - select the LocalService account as a minimum, but you may have to use the NetworkService or LocalSystem account if your service requires more privileges
  8. Select the serviceInstaller1 component in the designer. In the Property Grid, consider setting the following properties:
    • (Name) - give you object an intuitive name, e.g., serviceInstaller
    • Description - the service's description which will show up in the SCM for your service
    • DisplayName - the friendly name for your service which will show up in the SCM for your service
    • ServiceName - make sure this is the same name that you selected for the ServiceName property of your ServiceExample component (see Step 4)
    • StartType - indicate if you want the service to start automatically or manually
  9. Remember that I said I prefer writing events to my own event log instead of the Application event log. To do this, you'll need to replace the default EventLogInstaller in your ProjectInstaller with a custom one. Make your code for your ProjectInstaller look like this:
using System.Diagnostics;
[RunInstaller(true)]
public partial class ProjectInstaller : Installer
{
    public ProjectInstaller()
    {
        InitializeComponent();

        EventLogInstaller installer = FindInstaller(this.Installers);
        if (installer != null)
        {
            installer.Log = "ServiceExample"; // enter your event log name here
        }
    }

    private EventLogInstaller FindInstaller(InstallerCollection installers)
    {
        foreach (Installer installer in installers)
        {
            if (installer is EventLogInstaller)
            {
                return (EventLogInstaller)installer;
            }

            EventLogInstaller eventLogInstaller = FindInstaller(installer.Installers);
            if (eventLogInstaller != null)
            {
                return eventLogInstaller;
            }
        }
        return null;
    }
}

At this point, you can build your project to get your Windows service executable. To install your service, open the Visual Studio 2008 command prompt, and navigate to the Debug or Release directory where your executable is. At the command prompt, type the following: InstallUtil ServiceExample.exe. This will install your service on the local machine. To uninstall it, type the following at the command prompt: InstallUtil /u ServiceExample.exe

As long as your service is not running, you can make changes to your service and re-build, i.e., you do not have to uninstall your service to make changes to it. However, you will be unable to overwrite the executable with your fixes and enhancements as long as it is running.

To see your service in action, open the ServiceExample.cs file and make the following changes:

using System.Diagnostics;
public partial class ServiceExample : ServiceBase
{
    public ServiceExample()
    {
        // Uncomment this line to debug the service.
        //Debugger.Break();

        InitializeComponent();

        // Ties the EventLog member of the ServiceBase base class to the
        // ServiceExample event log created when the service was installed.
        EventLog.Log = "ServiceExample";
    }

    protected override void OnStart(string[] args)
    {
        EventLog.WriteEntry("The service was started successfully.", EventLogEntryType.Information);
    }

    protected override void OnStop()
    {
        EventLog.WriteEntry("The service was stopped successfully.", EventLogEntryType.Information);
    }

    protected override void OnShutdown()
    {
        EventLog.WriteEntry("The service was shutdown successfully", EventLogEntryType.Information);
    }
}

Once you run your service with these changes, you can look at the ServiceExample event log in the Event Viewer and see the messages logged there.

Hope this helps.

EDIT: If you prefer to use the Application event log for your event logging instead of a custom one, simply make no changes to the ProjectInstaller.cs file. In addition, leave out the line that sets the Log property of the EventLog in the ServiceExample constructor. When you run your service, your log messages will appear in the Application event log.

Related Question