backported clarifications to Wait() semantics from HEAD

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_8_BRANCH@45130 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2007-03-30 11:53:20 +00:00
parent 7e7c2a6715
commit 6e165a8d49

View File

@@ -461,10 +461,11 @@ See also \helpref{Sleep()}{wxthreadsleep}.
\constfunc{ExitCode}{Wait}{\void}
Gracefully terminates a joinable thread, either when the thread calls
\helpref{TestDestroy}{wxthreadtestdestroy} or finished processing, and
returns the value the thread returned from
\helpref{wxThread::Entry}{wxthreadentry} or {\tt (ExitCode)-1} on error.
Waits for a joinable thread to terminate and returns the value the thread
returned from \helpref{wxThread::Entry}{wxthreadentry} or {\tt (ExitCode)-1} on
error. Notice that, unlike \helpref{Delete}{wxthreaddelete} doesn't cancel the
thread in any way so the caller waits for as long as it takes to the thread to
exit.
You can only Wait() for joinable (not detached) threads.