diff options
author | Joel Sherrill <joel.sherrill@OARcorp.com> | 1998-11-19 16:06:46 +0000 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 1998-11-19 16:06:46 +0000 |
commit | c4dddee3f5d2714e0a5cb9a137cb01e7cf2adf2a (patch) | |
tree | 4ff7c2624fe2f3d21024fd67d15dbb78a03e934e /doc/posix_users/key.t | |
parent | New files (diff) | |
download | rtems-c4dddee3f5d2714e0a5cb9a137cb01e7cf2adf2a.tar.bz2 |
Major update/merge of POSIX manual.
Diffstat (limited to 'doc/posix_users/key.t')
-rw-r--r-- | doc/posix_users/key.t | 140 |
1 files changed, 140 insertions, 0 deletions
diff --git a/doc/posix_users/key.t b/doc/posix_users/key.t new file mode 100644 index 0000000000..58e34bb259 --- /dev/null +++ b/doc/posix_users/key.t @@ -0,0 +1,140 @@ +@c +@c COPYRIGHT (c) 1988-1998. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@chapter Key Manager + +@section Introduction + +The key manager ... + +The directives provided by the key manager are: + +@itemize @bullet +@item @code{pthread_key_create} - +@item @code{pthread_key_delete} - +@item @code{pthread_setspecific} - +@item @code{pthread_getspecific} - +@end itemize + +@section Background + +There is currently no text in this section. + +@section Operations + +There is currently no text in this section. + +@section Directives + +This section details the key manager's directives. +A subsection is dedicated to each of this manager's directives +and describes the calling sequence, related constants, usage, +and status codes. + +@page +@subsection pthread_key_create + +@subheading CALLING SEQUENCE: + +@example +#include <pthread.h> + +int pthread_key_create( + pthread_key_t *key, + void (*destructor)( void * ) +); +@end example + +@subheading STATUS CODES: + +@table @b +@item EAGAIN +There were not enough resources available to create another key. + +@item ENOMEM +Insufficient memory exists to create the key. + +@end table + +@page +@subsection pthread_key_delete + +@subheading CALLING SEQUENCE: + +@example +#include <pthread.h> + +int pthread_key_delete( + pthread_key_t key, +); +@end example + +@subheading STATUS CODES: + +@table @b +@item EINVAL +The key was invalid + +@end table + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection pthread_setspecific + +@subheading CALLING SEQUENCE: + +@example +#include <pthread.h> + +int pthread_setspecific( + pthread_key_t key, + const void *value +); +@end example + +@subheading STATUS CODES: +@table @b +@item EINVAL +The specified key is invalid. + +@end table + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection pthread_getspecific + +@subheading CALLING SEQUENCE: + +@example +#include <pthread.h> + +void *pthread_getspecific( + pthread_key_t key +); +@end example + +@subheading STATUS CODES: +@table @b +@item NULL +There is no thread-specific data associated with the specified key. + +@item non-NULL +The data associated with the specified key. + +@end table + +@subheading DESCRIPTION: + +@subheading NOTES: + |