View source for c/thread/mtx trylock

{{c/title|mtx_trylock}}
{{c/thread/navbar}}
{{ddcl | header=threads.h | since=c11 |
int mtx_trylock( mtx_t *mutex );
}}

Tries to lock the mutex pointed to by {{tt|mutex}} without blocking. Returns immediately if the mutex is already locked.

Prior calls to {{lc|mtx_unlock}} on the same mutex ''synchronize-with'' this operation (if this operation succeeds), and all lock/unlock operations on any given mutex form a single total order (similar to the modification order of an atomic)

===Parameters===
{{par begin}}
{{par | mutex | pointer to the mutex to lock}}
{{par end}}

===Return value===
{{lc|thrd_success}} if successful, {{lc|thrd_busy}} if the mutex has already been locked or due to a spurious failure to acquire an available mutex, {{lc|thrd_error}} if an error occurs.

===Defect reports===
{{dr list begin}}
{{dr list item|wg=c|dr=470|std=C11|before={{tt|mtx_trylock}} was not allowed to fail spuriously|after=allowed}}
{{dr list end}}

===References===
{{ref std c17}}
{{ref std | section=7.26.4.5 | title=The mtx_trylock function | p=278-279}}
{{ref std end}}
{{ref std c11}}
{{ref std | section=7.26.4.5 | title=The mtx_trylock function | p=382}}
{{ref std end}}

===See also===
{{dsc begin}}
{{dsc inc | c/thread/dsc mtx_lock}}
{{dsc inc | c/thread/dsc mtx_timedlock}}
{{dsc inc | c/thread/dsc mtx_unlock}}
{{dsc see cpp | cpp/thread/mutex/try_lock | mutex::try_lock}}
{{dsc see cpp | cpp/thread/timed_mutex/try_lock | timed_mutex::try_lock}}
{{dsc see cpp | cpp/thread/recursive_mutex/try_lock | recursive_mutex::try_lock}}
{{dsc see cpp | cpp/thread/recursive_timed_mutex/try_lock | recursive_timed_mutex::try_lock}}
{{dsc end}}

{{langlinks|ar|cs|de|es|fr|it|ja|ko|pl|pt|ru|tr|zh}}