pthread_mutex_lock(3)

pthread_mutex_lock3

Lock a mutex

Usage

#include <pthread.h>

int

pthread_mutex_lock(pthread_mutex_t *mutex);

Overview

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.

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_lock() 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.