pthread_mutex_trylock(3)

pthread_mutex_trylock3

Attempt to lock a mutex without blocking

Usage

#include <pthread.h>

int

pthread_mutex_trylock(pthread_mutex_t *mutex);

Overview

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

The pthread_mutex_trylock() function will fail if:

[EINVAL]

The value specified by mutex is invalid.

[EBUSY]

Mutex is already locked.

Releases

149 releases since Mac OS X 10.2; the text changed 2 times.

  1. 10.2–10.4.11
  2. 10.5–10.11.6
  3. 10.12–26.5

Standards

The pthread_mutex_trylock() function conforms to ISO/IEC 9945-1:1996 (“POSIX.1”).

From libpthread 539.100.4 in macOS 26.5. Parsed by carta from the page's mdoc source.