docs/latex/wx/crtslock.tex

   1 \section{\class{wxCriticalSectionLocker}}\label{wxcriticalsectionlocker}
   2
   3 This is a small helper class to be used with \helpref{wxCriticalSection}{wxcriticalsection}
   4 objects. A wxCriticalSectionLocker enters the critical section in the
   5 constructor and leaves it in the destructor making it much more difficult to
   6 forget to leave a critical section (which, in general, will lead to serious
   7 and difficult to debug problems).
   8
   9 \wxheading{Derived from}
  10
  11 None.
  12
  13 \wxheading{Include files}
  14
  15 <wx/thread.h>
  16
  17 \wxheading{See also}
  18
  19 \helpref{wxCriticalSection}{wxcriticalsection},
  20 \helpref{wxMutexLocker}{wxmutexlocker}
  21
  22 \latexignore{\rtfignore{\wxheading{Members}}}
  23
  24 \membersection{wxCriticalSectionLocker::wxCriticalSectionLocker}\label{wxcriticalsectionlockerctor}
  25
  26 \func{}{wxCriticalSectionLocker}{\param{wxCriticalSection *}{criticalsection}}
  27
  28 Constructs a wxCriticalSectionLocker object associated with given
  29 criticalsection which must be non NULL and enters it.
  30
  31 \membersection{wxCriticalSectionLocker::\destruct{wxCriticalSectionLocker}}\label{wxcriticalsectionlockerdtor}
  32
  33 \func{}{\destruct{wxCriticalSectionLocker}}{\void}
  34
  35 Destuctor leaves the criticalsection.
  36