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

Limiting your .NET apps to a single instance

, 3 Nov 2001
Rate this:
Please Sign up or sign in to vote.
Shows how to use the Mutex class to limit your app to a single instance using a named mutex

Introduction

Sometimes you'd want to limit your application to a single instance. In Win32 we had the CreateMutex API function using which we could create a named mutex and if the call failed, we assume that the application is already running. Well the .NET SDK gives us the Mutex class for inter-thread/inter-process synchronization. Anyway in this article we are more interested in using the Mutex class to limit our apps to a single instance rather than in its use as an inter-process data synchronization object.

The Class

The code below is nothing new. It's simply a .NET version of a universal technique that has been used pretty much successfully over the years. For a thorough understanding of this technique and other techniques and issues involved when making single instance applications, you must read Joseph M Newcomer's article - Avoiding Multiple Instances of an Application

__gc class CSingleInstance
{
private:
    //our Mutex member variable
    Mutex *m_mutex;	
public:
    CSingleInstance(String *mutexname)
    {
        m_mutex=new Mutex(false,mutexname);
    }
    ~CSingleInstance()
    {
        //we must release it when the CSingleInstance object is destroyed
        m_mutex->ReleaseMutex ();
    }
    bool IsRunning()
    {
        //you can replace 10 with 1 if you want to save 9 ms
        return !m_mutex->WaitOne(10,true);           
    }
};

Using it in your program

int __stdcall WinMain()
{
    //create a mutex with a unique name   
    CSingleInstance *si=
        new CSingleInstance("{94374E65-7166-4fde-ABBD-4E943E70E8E8}");
    if(si->IsRunning())
        MessageBox::Show("Already running...so exiting!");
    else
        Application::Run(new MainForm());
    return 0;
}

Remember to put the following line on top of your program.

using namespace System::Threading;

I have used the string {94374E65-7166-4fde-ABBD-4E943E70E8E8}as my unique mutex name. You can use a name that you believe will be unique to your application. Using a GUID would be the smartest option obviously. You can put the class in a DLL and thus you can use it from all your applications.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

About the Author

Nish Sivakumar

United States United States
Nish is a real nice guy who has been writing code since 1990 when he first got his hands on an 8088 with 640 KB RAM. Originally from sunny Trivandrum in India, he has been living in various places over the past few years and often thinks it’s time he settled down somewhere.
 
Nish has been a Microsoft Visual C++ MVP since October, 2002 - awfully nice of Microsoft, he thinks. He maintains an MVP tips and tricks web site - www.voidnish.com where you can find a consolidated list of his articles, writings and ideas on VC++, MFC, .NET and C++/CLI. Oh, and you might want to check out his blog on C++/CLI, MFC, .NET and a lot of other stuff - blog.voidnish.com.
 
Nish loves reading Science Fiction, P G Wodehouse and Agatha Christie, and also fancies himself to be a decent writer of sorts. He has authored a romantic comedy Summer Love and Some more Cricket as well as a programming book – Extending MFC applications with the .NET Framework.
 
Nish's latest book C++/CLI in Action published by Manning Publications is now available for purchase. You can read more about the book on his blog.
 
Despite his wife's attempts to get him into cooking, his best effort so far has been a badly done omelette. Some day, he hopes to be a good cook, and to cook a tasty dinner for his wife.

Comments and Discussions

 
Generaldoesn't work in a release build PinsussAnonymous28-Jun-04 12:31 
GeneralRe: doesn't work in a release build PinmemberKluch27-Oct-04 13:25 
AnswerRe: doesn't work in a release build Pinmemberricecake12-Mar-07 10:50 
GeneralQuestion on how to add bring to foreground Pinmembersmesser29-Feb-04 8:14 
GeneralException in ReleaseMutex() in destructor PinsussSerge T11-Mar-03 7:16 
GeneralRe: Simplest Way To Make Single Instance Application PinmemberNish [BusterBoy]13-May-02 23:38 
GeneralRe: Simplest Way To Make Single Instance Application PinmemberAnonymous14-May-02 0:13 
GeneralRe: Simplest Way To Make Single Instance Application PinmemberA.R Gupta14-May-02 0:14 
GeneralA better way PinmemberAndy Smith4-Mar-02 11:06 
GeneralRe: A better way PinmemberRamu Pulipati26-Jun-02 5:08 
GeneralRe: A better way PinmemberJay Giganti27-Sep-05 3:47 
Generalmutex name PinmemberKannan Kalyanaraman9-Nov-01 23:02 
GeneralRe: mutex name PinmemberNish [BusterBoy]9-Nov-01 23:05 
GeneralNothing new, see details MS Knowledge base Q243953 PinmemberMN4-Nov-01 15:46 
GeneralRe: Nothing new, see details MS Knowledge base Q243953 PinmemberNish [BusterBoy]4-Nov-01 16:09 
GeneralRe: Nothing new, see details MS Knowledge base Q243953 PinmemberDenaliChief26-Dec-01 4:33 
GeneralRe: Nothing new, see details MS Knowledge base Q243953 PinmemberNish [BusterBoy]26-Dec-01 16:04 
GeneralRe: Nothing new, see details MS Knowledge base Q243953 PinmemberTom Archer26-Feb-02 17:30 
GeneralRe: Nothing new, see details MS Knowledge base Q243953 PinsussAnonymous7-Oct-02 18:38 
GeneralWell Done PinmemberColin Davies3-Nov-01 22:45 
GeneralRe: Well Done PinmemberNish [BusterBoy]3-Nov-01 22:49 
GeneralRe: Well Done PinmemberZac Howland4-Jun-02 5:41 
GeneralRe: Well Done PinmemberNish - Native CPian4-Jun-02 6:03 
GeneralRe: Well Done PinmemberZac Howland4-Jun-02 6:15 
GeneralRe: Well Done PinmemberNish - Native CPian4-Jun-02 6:43 

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
Web03 | 2.8.140721.1 | Last Updated 4 Nov 2001
Article Copyright 2001 by Nish Sivakumar
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid