This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

PTHREAD_MUTEX_INIT(3)    BSD Library Functions Manual    PTHREAD_MUTEX_INIT(3)

NAME
     pthread_mutex_init -- create a mutex

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
     pthread_mutex_init() will fail if:

     [EAGAIN]           The system temporarily lacks the resources to create another mutex.

     [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)

STANDARDS
     pthread_mutex_init() conforms to ISO/IEC 9945-1:1996 (``POSIX.1'').

BSD                              July 29, 1998                             BSD