[#BloombergLP-bslmt-ThreadUtil-join]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslmt.adoc[bslmt]::xref:BloombergLP/bslmt/ThreadUtil.adoc[ThreadUtil]::join
:relfileprefix: ../../../
:mrdocs:

Wait for the specified thread to terminate and reclaim its resources.

== Synopsis

Declared in `<bslmt_threadutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
join(
    xref:BloombergLP/bslmt/ThreadUtil/Handle.adoc[Handle]& threadHandle,
    void** status = 0);
----

== Description

Suspend execution of the current thread until the thread referred to by the specified `threadHandle` terminates, and reclaim any system resources associated with `threadHandle`. Return 0 on success, and a non‐zero value otherwise. If the optionally specified `status` is not 0, load into `*status` the value returned by the function supplied at the creation of the thread identified by `threadHandle`. The behavior is undefined unless `threadHandle` was obtained by a call to `create`.

== Return Value

0 on success, and a non‐zero value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *threadHandle*
| thread to wait for
| *status*
| if non‐null, receives the thread's exit status
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#