.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxSingleInstanceChecker 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxSingleInstanceChecker \- 
  Check that only single program instance is running
 
.SH DESCRIPTION

  


   wxSingleInstanceChecker class allows to check that only a single instance of
   a program is running. To do it, you should create an object of this class. As
   long as this object is alive, calls to
   IsAnotherRunning()
   from other processes will return
   true
   .
  
  


   As the object should have the life span as big as possible, it makes sense to
   create it either as a global or in
   wxApp::OnInit
   . For example:
  
  


  
bool MyApp::OnInit()
{
    const wxString name = wxString::Format("MyApp-
    m_checker = new wxSingleInstanceChecker(name);
    if ( m_checker->IsAnotherRunning() )
    {
        wxLogError(_("Another program instance is already running, aborting."));

        return false;
    }

    ... more initializations ...

    return true;
}

int MyApp::OnExit()
{
    delete m_checker;

    return 0;
}

  


  


   Note using
   wxGetUserId()
   to construct the name: this allows different user to run the application
   concurrently which is usually the intended goal. If you don't use the user
   name in the wxSingleInstanceChecker name, only one user would be able to run
   the application at a time.
  
  


   This class is implemented for Win32 and Unix platforms (supporting
   fcntl()
   system call, but almost all of modern Unix systems do) only.
  
 
.SH "PARENTS"

.SH "INCLUDE FILES"
wx/snglinst.h
.SH MEMBERS

  
.SS  wxSingleInstanceChecker ()

     


      Default ctor, use
      Create()
      after it.
     
    
.SS  wxSingleInstanceChecker (const wxString& nameconst wxString& path = wxEmptyString)

     


      Like
      Create()
      but without error checking.
     
    
   
  
.SS bool Create (const wxString& nameconst wxString& path = wxEmptyString)

     


      Initialize the object if it had been created using the default
      constructor. Note that you can't call Create() more than once, so calling
      it if the
      non default ctor
      had been used is an error.
     
    
   
  
.SS bool IsAnotherRunning ()

     


      Returns
      true
      if another copy of this program is already running,
      false
      otherwise.
     
    
   
  
.SS  ~wxSingleInstanceChecker ()

     


      Destructor frees the associated resources.
     
     


      Note that it is not virtual, this class is not meant to be used
      polymorphically
     
    
 
.SH "SEE ALSO"

.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.