pthread_mutex_init(3)

pthread_mutex_init3

Create a mutex

Usage

#include <pthread.h>

int

pthread_mutex_init(pthread_mutex_t *mutex, const pthread_mutexattr_t *attr);

Overview

The pthread_mutex_init() function creates a new mutex, with attributes specified with attr. If attr is NULL the default attributes are used.

Return values

If successful, pthread_mutex_init() will return zero and put the new mutex id into mutex, otherwise an error number will be returned to indicate the error.

Errors

The pthread_mutex_init() function will fail if:

[EINVAL]

The value specified by attr is invalid.

[ENOMEM]

The process cannot allocate enough memory to create another 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_init() 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.