man pages section 3: Basic Library Functions

Exit Print View

Updated: July 2014
 
 

pthread_key_delete(3C)

Name

pthread_key_delete - delete thread-specific data key

Synopsis

cc –mt [ flag... ] file... [ library... ]
#include <pthread.h>

int pthread_key_delete(pthread_key_t key);

Description

The pthread_key_delete() function deletes a thread-specific data key previously returned by pthread_key_create(). The thread-specific data values associated with key need not be NULL at the time pthread_key_delete() is called. It is the responsibility of the application to free any application storage or perform any cleanup actions for data structures related to the deleted key or associated thread-specific data in any threads; this cleanup can be done either before or after pthread_key_delete() is called. Any attempt to use key following the call to pthread_key_delete() results in undefined behaviour.

The pthread_key_delete() function is callable from within destructor functions. No destructor functions will be invoked by pthread_key_delete(). Any destructor function that may have been associated with key will no longer be called upon thread exit.

Return Values

If successful, the pthread_key_delete() function returns 0. Otherwise, an error number is returned to indicate the error.

Errors

The pthread_key_delete() function may fail if:

EINVAL

The key value is invalid.

The pthread_key_delete() function will not return an error code of EINTR.

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
MT-Safe
Standard

See Also

pthread_key_create(3C), attributes(5), standards(5)