NAME

pthread_key_delete - thread-specific data key deletion

 SYNOPSIS

#include <pthread.h>

int pthread_key_delete(pthread_key_t key);

 DESCRIPTION

This 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 VALUE

If successful, the pthread_key_delete() function returns zero. 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].

 EXAMPLES

None.

 APPLICATION USAGE

None.

 FUTURE DIRECTIONS

None.

 SEE ALSO

pthread_key_create(), <pthread.h>.

DERIVATION

Derived from the POSIX Threads Extension (1003.1c-1995)