.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxMutexLocker 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxMutexLocker \- 
  Mutex locker utility class
 
.SH DESCRIPTION

  


   This is a small helper class to be used with
   wxMutex
   objects. A wxMutexLocker acquires a mutex lock in the constructor and
   releases (or unlocks) the mutex in the destructor making it much more
   difficult to forget to release a mutex (which, in general, will promptly lead
   to the serious problems). See
   wxMutex
   for an example of wxMutexLocker usage.
  
 
.SH "PARENTS"

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

  
.SS  wxMutexLocker (wxMutex& mutex)

     


      Constructs a wxMutexLocker object associated with mutex and locks it. Call
      IsLocked
      to check if the mutex was successfully locked.
     
    
   
  
.SS  ~wxMutexLocker ()

     


      Destructor releases the mutex if it was successfully acquired in the ctor.
     
    
   
  
.SS bool IsOk ()

     


      Returns true if mutex was acquired in the constructor, false otherwise.
     
    
 
.SH "SEE ALSO"

  wxMutex
  wxCriticalSectionLocker
 
.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.