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_LOCK(3)    BSD Library Functions Manual    PTHREAD_MUTEX_LOCK(3)

NAME
     pthread_mutex_lock -- lock a mutex

SYNOPSIS
     #include <pthread.h>

     int
     pthread_mutex_lock(pthread_mutex_t *mutex);

DESCRIPTION
     The pthread_mutex_lock() function locks mutex.  If the mutex is already locked, the calling thread will
     block until the mutex becomes available.

RETURN VALUES
     If successful, pthread_mutex_lock() will return zero.  Otherwise, an error number will be returned to
     indicate the error.

ERRORS
     pthread_mutex_lock() will fail if:

     [EDEADLK]          A deadlock would occur if the thread blocked waiting for mutex.

     [EINVAL]           The value specified by mutex is invalid.

SEE ALSO
     pthread_mutex_destroy(3), pthread_mutex_init(3), pthread_mutex_trylock(3), pthread_mutex_unlock(3)

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

BSD                              July 30, 1998                             BSD