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_TRYLOCK(3) BSD Library Functions Manual PTHREAD_MUTEX_TRYLOCK(3)

NAME
     pthread_mutex_trylock -- attempt to lock a mutex without blocking

SYNOPSIS
     #include <pthread.h>

     int
     pthread_mutex_trylock(pthread_mutex_t *mutex);

DESCRIPTION
     The pthread_mutex_trylock() function locks mutex.  If the mutex is already locked,
     pthread_mutex_trylock() will not block waiting for the mutex, but will return an error condition.

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

ERRORS
     pthread_mutex_trylock() will fail if:

     [EBUSY]            Mutex is already locked.

     [EINVAL]           The value specified by mutex is invalid.

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

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

BSD                              July 30, 1998                             BSD