pthread_key_delete(3) [freebsd man page]

PTHREAD_KEY_DELETE(3)					   BSD Library Functions Manual 				     PTHREAD_KEY_DELETE(3)

NAME

     pthread_key_delete -- delete a thread-specific data key

LIBRARY

     POSIX Threads Library (libpthread, -lpthread)

SYNOPSIS

     #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 that 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 behavior.

     The pthread_key_delete() function is callable from within destructor functions.  Destructor functions are not 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 will return zero.  Otherwise an error number will be returned to indicate the error.

ERRORS

     The pthread_key_delete() function will fail if:

     [EINVAL]		The key value is invalid.

SEE ALSO

     pthread_getspecific(3), pthread_key_create(3), pthread_setspecific(3)

STANDARDS

     The pthread_key_delete() function conforms to ISO/IEC 9945-1:1996 (``POSIX.1'').

BSD
								   April 4, 1996							       BSD

pthread_key_delete(3)					     Library Functions Manual					     pthread_key_delete(3)

NAME

       pthread_key_delete - Deletes a thread-specific data key.

LIBRARY

       DECthreads POSIX 1003.1c Library (libpthread.so)

SYNOPSIS

       #include <pthread.h>

       int   pthread_key_delete(
			      pthread_key_t   key);

STANDARDS

       Interfaces documented on this reference page conform to industry standards as follows:

       IEEE Std 1003.1c-1995, POSIX System Application Program Interface

PARAMETERS

       Context key to be deleted.

DESCRIPTION

       This  routine  deletes  the  thread-specific  data  key	specified  by  the  key  argument,  which  must  have  been previously returned by
       pthread_key_create(3).

       The thread-specific data values associated with key need not be NULL at the time this routine is called.  The  application  must  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 this routine is called.

       Do not attempt to use the key after calling this routine; this results in unpredictable behavior.

       No destructor functions are invoked by this routine.  Any destructor functions that may have been associated with key shall  no	longer	be
       called upon thread exit.  pthread_key_delete(3) can be called from within destructor functions.

RETURN VALUES

       If  an  error condition occurs, this routine returns an integer value indicating the type of error.  Possible return values are as follows:
       Successful completion.  The key value is an invalid argument.

ERRORS

       None

RELATED INFORMATION

       Functions: pthread_exit(3), pthread_getspecific(3), pthread_key_create(3)

       Manuals: Guide to DECthreads and Programmer's Guide

       delim off

															     pthread_key_delete(3)