pthread_mutexattr_getrecursive()

Updated: April 19, 2023

Get the recursive attribute from a mutex attribute object

Synopsis:

#include <pthread.h>

int pthread_mutexattr_getrecursive(
        const pthread_mutexattr_t* attr,
        int* recursive );

Arguments:

attr
A pointer to the pthread_mutexattr_t object that you want to get the attribute from.
pshared
A pointer to a location where the function can store the recursive attribute.

Library:

libc

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

Description:

The pthread_mutexattr_getrecursive() function gets the recursive attribute from the mutex attribute object attr and stores it in recursive.

If the recursive attribute is set to PTHREAD_RECURSIVE_ENABLE, a thread that has already locked the mutex can lock it again without blocking. If the recursive attribute is set to PTHREAD_RECURSIVE_DISABLE, any thread that tries to lock the mutex will block, if that mutex is already locked.

The default value of the recursive attribute is PTHREAD_RECURSIVE_DISABLE.

Returns:

EOK
Success.
EINVAL
Invalid mutex attribute object attr.

Classification:

QNX Neutrino

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