pthread_setspecific(3)

pthread_setspecific3

Set a thread-specific data value

Usage

#include <pthread.h>

int

pthread_setspecific(pthread_key_t key, const void *value);

Overview

The pthread_setspecific() function associates a thread-specific value with a key obtained via a previous call to pthread_key_create(). Different threads can bind different values to the same key. These values are typically pointers to blocks of dynamically allocated memory that have been reserved for use by the calling thread.

The effect of calling pthread_setspecific() with a key value not obtained from pthread_key_create() or after key has been deleted with pthread_key_delete() is undefined.

The pthread_setspecific() function may be called from a thread-specific data destructor function, however this may result in lost storage or infinite loops.

Return values

If successful, the pthread_setspecific() function will return zero. Otherwise an error number will be returned to indicate the error.

Errors

The pthread_setspecific() function will fail if:

[ENOMEM]

Insufficient memory exists to associate the value with the key.

[EINVAL]

The key value is invalid.

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