FreeBSD manual

download PDF document: pthread_mutex_init.3.pdf

PTHREAD_MUTEX_INIT(3) FreeBSD Library Functions Manual PTHREAD_MUTEX_INIT(3)
NAME pthread_mutex_init - create a mutex
LIBRARY POSIX Threads Library (libpthread, -lpthread)
SYNOPSIS #include <pthread.h>
int pthread_mutex_init(pthread_mutex_t *restrict mutex, const pthread_mutexattr_t *restrict attr);
DESCRIPTION The pthread_mutex_init() function creates a new mutex, with attributes specified with attr. If attr is NULL the default attributes are used.
RETURN VALUES If successful, pthread_mutex_init() will return zero and put the new mutex id into mutex, otherwise an error number will be returned to indicate the error.
ERRORS The pthread_mutex_init() function will fail if:
[EINVAL] The value specified by attr is invalid.
[ENOMEM] The process cannot allocate enough memory to create another mutex.
SEE ALSO pthread_mutex_destroy(3), pthread_mutex_lock(3), pthread_mutex_trylock(3), pthread_mutex_unlock(3), pthread_mutexattr(3)
STANDARDS The pthread_mutex_init() function conforms to ISO/IEC 9945-1:1996 ("POSIX.1").
FreeBSD 14.0-RELEASE-p11 August 17, 2018 FreeBSD 14.0-RELEASE-p11