freebsd man page for pthread_mutex_lock

PTHREAD_MUTEX_LOCK(3)					   BSD Library Functions Manual 				     PTHREAD_MUTEX_LOCK(3)

NAME
     pthread_mutex_lock -- lock a mutex

LIBRARY
     POSIX Threads Library (libpthread, -lpthread)

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 avail-
     able.

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

ERRORS
     The pthread_mutex_lock() function will fail if:

     [EINVAL]		The value specified by mutex is invalid.

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

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

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

BSD
								 January 31, 2006							       BSD