Click here to Skip to main content
Click here to Skip to main content

Debugging Windows Services under Visual Studio .NET

By , 14 Aug 2006
Rate this:
Please Sign up or sign in to vote.

Introduction

Normally, debugging a Windows service under Visual Studio .NET is painful. Windows services won't actually run directly within Visual Studio .NET, so the usual technique is to install and start the Windows service and then attach a debugger to it. An alternative approach is to pull the guts out of the service, stick it in a separate library, and then build some other app (e.g., a console app) to sit in front of it. This approach uses neither of those techniques.

When building a C# Windows Service project in Visual Studio, it will leave you with a class containing quite a few methods including a Main(), such as this:

// The main entry point for the process
static void Main()
{
    System.ServiceProcess.ServiceBase[] ServicesToRun;

    // More than one user Service may run within the same process. To add
    // another service to this process, change the following line to
    // create a second service object. For example,
    //
    // ServicesToRun = new 
    //      System.ServiceProcess.ServiceBase[] {new Service1(), 
    //      new MySecondUserService()};
    //

    ServicesToRun = new System.ServiceProcess.ServiceBase[] { new Service1() };
    System.ServiceProcess.ServiceBase.Run(ServicesToRun);
}

Obviously, it's the Main() above that ends up executing the service, and it's the Main() that this approach manipulates so that the Windows Service can be debugged directly within Visual Studio .NET.

Using the example above (and removing some of the comments), here's how:

// The main entry point for the process
static void Main()
{
#if (!DEBUG)
    System.ServiceProcess.ServiceBase[] ServicesToRun;
    ServicesToRun = new System.ServiceProcess.ServiceBase[] { new Service1() };
    System.ServiceProcess.ServiceBase.Run(ServicesToRun);
#else
    // Debug code: this allows the process to run as a non-service.
    // It will kick off the service start point, but never kill it.
    // Shut down the debugger to exit
    Service1 service = new Service1();
    service.<Your Service's Primary Method Here>();
    // Put a breakpoint on the following line to always catch
    // your service when it has finished its work
    System.Threading.Thread.Sleep(System.Threading.Timeout.Infinite);
#endif 
}

It's crude, but effective (CBE - also known as Commander of the British Empire Wink | ;) ). Run the service in debug mode to debug it, compile and install it as a release build, and it's a full and proper Windows service.

You may still wish to pull the guts out of your service into a separate library for unit testing. But this approach allows you to work with almost all of your service code as an actual service.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Author

Lee Humphries
Founder md8n
Australia Australia
If it ain't broke - that can be arranged.
Follow on   Twitter

Comments and Discussions

 
GeneralMy vote of 5 PinmemberSagar Shivdas Raut13-Mar-14 2:44 
GeneralMy vote of 5 PinmemberSharadGNair13-Aug-13 23:43 
QuestionI’m still getting the message after changing code. PinmemberLuis Fernando Forero Guzman19-Dec-12 5:20 
AnswerRe: I’m still getting the message after changing code. PinmemberLee Humphries19-Dec-12 11:45 
GeneralMy vote of 5 Pinmembermenarenprvn22-Oct-12 4:19 
QuestionVery nice - be careful of OnStart PinmemberRitchie Annand11-Sep-12 8:43 
QuestionHow to handle the Stop request PinmemberBernhard Hiller23-May-12 3:33 
AnswerRe: How to handle the Stop request PinmemberLee Humphries23-May-12 13:07 
GeneralMy vote of 5 PinmemberDavid Rodriguez29-Apr-12 9:45 
GeneralMy vote of 5 Pinmembereka80824-Apr-12 4:50 
QuestionSo Cool! PinmemberMarlene Deyo20-Mar-12 4:18 
QuestionLife saver! PinadminChris Maunder12-Oct-11 11:54 
AnswerRe: Life saver! Pinmemberkicker20129-Jul-12 2:57 
QuestionTry Windows Service Helper Pinmemberbreakpoint20-Sep-11 16:44 
GeneralSimple things are often the best! PinmemberMember 385355321-Jul-11 21:48 
GeneralMy vote of 5 PinmemberDragonLord663-May-11 23:24 
GeneralMy vote of 5 Pinmembercable beach20-Apr-11 17:30 
GeneralDebugging Windows service in simple way PinmemberKrishna Mohan Reddy N8-Apr-11 3:53 
GeneralRe: Debugging Windows service in simple way PinmemberLee Humphries10-Apr-11 13:50 
GeneralMy vote of 5 Pinmemberrohancragg6-Jan-11 23:11 
GeneralMy vote of 5 Pinmembervisionmaster50529-Dec-10 9:12 
GeneralMy vote of 5 Pinmemberalexdresko17-Nov-10 9:40 
GeneralMy vote of 5 PinmemberMuraliDhar_A20-Aug-10 0:45 
Generalsuper thx !! Pinmemberfasafr26-Apr-10 1:34 
GeneralIt worked. Thanks! PinmemberVijay Paramasivam Rajasekaran12-Apr-10 5:56 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web01 | 2.8.140415.2 | Last Updated 14 Aug 2006
Article Copyright 2005 by Lee Humphries
Everything else Copyright © CodeProject, 1999-2014
Terms of Use
Layout: fixed | fluid