mtx_trylock()

Updated: October 26, 2022

Attempt to lock a mutex

Synopsis:

#include <threads.h>

int mtx_trylock( mtx_t *mutex );

Arguments:

mutex
A pointer to the mtx_t object that you want to try to lock.

Library:

libc

Use the -l c option to qcc to link against this library. This library is usually included automatically.

Description:

The mtx_trylock() function attempts to lock the mutex mutex, but doesn't block the calling thread if the mutex is already locked.

Returns:

thrd_success
Success.
thrd_busy
The mutex was already locked.
thrd_error
An error occurred.

Classification:

C11

Safety:  
Cancellation point No
Interrupt handler No
Signal handler Yes
Thread Yes