Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
PTHREAD_MUTEX_LOCK(3)	     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 available.

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.

     [EOWNERDEAD]	 The argument mutex points to a  robust  mutex	and  the
			 process  containing  the  previous owning thread termi-
			 nated while holding  the  mutex  lock.   The  lock  was
			 granted  to the caller and it is up to the new owner to
			 make the state consistent.

     [ENOTRECOVERABLE]	 The state protected by the mutex is not recoverable.

SEE ALSO
     pthread_mutex_consistent(3),     pthread_mutex_destroy(3),      pthread_mu-
     tex_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").

FreeBSD ports 15.1		 August 7, 2019 	   PTHREAD_MUTEX_LOCK(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=pthread_mutex_lock&sektion=3&manpath=FreeBSD+15.1-RELEASE+and+Ports>

home | help