X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/54946cc95b8493fb092b6a508bf22a1cd6fa4693..21db32c1294eff5c1b6b087d260d2accc17abb53:/docs/latex/wx/semaphor.tex

diff --git a/docs/latex/wx/semaphor.tex b/docs/latex/wx/semaphor.tex
index 9691e18c0d..dfd0796a1d 100644
--- a/docs/latex/wx/semaphor.tex
+++ b/docs/latex/wx/semaphor.tex
@@ -6,7 +6,7 @@
 %% Created:     02.04.02
 %% RCS-ID:      $Id$
 %% Copyright:   (c) 2002 Vadim Zeitlin
-%% License:     wxWindows license
+%% License:     wxWidgets license
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxSemaphore}}\label{wxsemaphore}
@@ -20,7 +20,7 @@ decrements the counter. As soon as it reaches $0$, any subsequent calls to
 counter becomes strictly positive again as the result of calling 
 \helpref{Post}{wxsemaphorepost} which increments the counter.
 
-In general, the semaphores are useful to restict access to a shared resource
+In general, the semaphores are useful to restrict access to a shared resource
 which can only be accessed by some fixed number of clients at once. For
 example, when modeling a hotel reservation system a semaphore with the counter
 equal to the total number of available rooms could be created. Each time a room
@@ -57,28 +57,78 @@ Destructor is not virtual, don't use this class polymorphically.
 
 \membersection{wxSemaphore::Post}\label{wxsemaphorepost}
 
-\func{void}{Post}{\void}
+\func{wxSemaError }{Post}{\void}
+
+Increments the semaphore count and signals one of the waiting
+threads in an atomic way. Returns wxSEMA\_OVERFLOW if the count
+would increase the counter past the maximum.
+
+\wxheading{Return value}
+
+One of:
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf wxSEMA\_NO\_ERROR}}{There was no error.}
+\twocolitem{{\bf wxSEMA\_INVALID}}{Semaphore hasn't been initialized successfully.}
+\twocolitem{{\bf wxSEMA\_OVERFLOW}}{Post() would increase counter past the max.}
+\twocolitem{{\bf wxSEMA\_MISC\_ERROR}}{Miscellaneous error.}
+\end{twocollist}
 
-Increments the semaphore count and signals one of the waiting threads in an
-atomic way.
 
 \membersection{wxSemaphore::TryWait}\label{wxsemaphoretrywait}
 
-\func{bool}{TryWait}{\void}
+\func{wxSemaError }{TryWait}{\void}
+
+Same as \helpref{Wait()}{wxsemaphorewait}, but returns immediately.
+
+\wxheading{Return value}
+
+One of:
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf wxSEMA\_NO\_ERROR}}{There was no error.}
+\twocolitem{{\bf wxSEMA\_INVALID}}{Semaphore hasn't been initialized successfully.}
+\twocolitem{{\bf wxSEMA\_BUSY}}{Returned by TryWait() if Wait() would block, i.e. the count is zero.}
+\twocolitem{{\bf wxSEMA\_MISC\_ERROR}}{Miscellaneous error.}
+\end{twocollist}
 
-Same as \helpref{Wait()}{wxsemaphorewait}, but does not block, returns
-{\tt TRUE} if the semaphore was successfully acquired and {\tt FALSE} if the
-count is zero and it couldn't be done.
 
 \membersection{wxSemaphore::Wait}\label{wxsemaphorewait}
 
-\func{void}{Wait}{\void}
+\func{wxSemaError }{Wait}{\void}
 
 Wait indefinitely until the semaphore count becomes strictly positive
 and then decrement it and return.
 
-\func{bool}{Wait}{\param{unsigned long }{timeout\_millis}}
+\wxheading{Return value}
+
+One of:
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf wxSEMA\_NO\_ERROR}}{There was no error.}
+\twocolitem{{\bf wxSEMA\_INVALID}}{Semaphore hasn't been initialized successfully.}
+\twocolitem{{\bf wxSEMA\_MISC\_ERROR}}{Miscellaneous error.}
+\end{twocollist}
+
+\membersection{wxSemaphore::WaitTimeout}\label{wxsemaphorewaittimeout}
+
+\func{wxSemaError }{WaitTimeout}{\param{unsigned
+long}{timeout\_millis}}
+
+Same as \helpref{Wait()}{wxsemaphorewait}, but with a timeout
+limit.
+
+\wxheading{Return value}
 
-Same as the version above, but with a timeout limit: returns {\tt TRUE} if the
-semaphore was acquired and {\tt FALSE} if the timeout has ellapsed
+One of:
 
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf wxSEMA\_NO\_ERROR}}{There was no error.}
+\twocolitem{{\bf wxSEMA\_INVALID}}{Semaphore hasn't been initialized successfully.}
+\twocolitem{{\bf wxSEMA\_TIMEOUT}}{Timeout occurred without receiving semaphore.}
+\twocolitem{{\bf wxSEMA\_MISC\_ERROR}}{Miscellaneous error.}
+\end{twocollist}