X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c9c537e6b06e7ca0160de52b7a91901aef0381e0..245b9db51823e59bd61f0d7c0c69b419495cf0b7:/docs/latex/wx/thread.tex diff --git a/docs/latex/wx/thread.tex b/docs/latex/wx/thread.tex index 12f9020b74..73ff763528 100644 --- a/docs/latex/wx/thread.tex +++ b/docs/latex/wx/thread.tex @@ -19,6 +19,10 @@ None. +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{wxMutex}{wxmutex}, \helpref{wxCondition}{wxcondition}, \helpref{wxCriticalSection}{wxcriticalsection} @@ -461,13 +465,15 @@ 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. This function can only be called from another thread context. See \helpref{wxThread deletion}{deletionwxthread} for a broader explanation of this routine. +