summaryrefslogtreecommitdiffstats
path: root/doc/posix_users/key.t
diff options
context:
space:
mode:
Diffstat (limited to 'doc/posix_users/key.t')
-rw-r--r--doc/posix_users/key.t152
1 files changed, 152 insertions, 0 deletions
diff --git a/doc/posix_users/key.t b/doc/posix_users/key.t
new file mode 100644
index 0000000000..8a317e7ace
--- /dev/null
+++ b/doc/posix_users/key.t
@@ -0,0 +1,152 @@
+@c
+@c COPYRIGHT (c) 1988-2002.
+@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} - Create Thread Specific Data Key
+@item @code{pthread_key_delete} - Delete Thread Specific Data Key
+@item @code{pthread_setspecific} - Set Thread Specific Key Value
+@item @code{pthread_getspecific} - Get Thread Specific Key Value
+@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.
+
+@c
+@c
+@c
+@page
+@subsection pthread_key_create - Create Thread Specific Data Key
+
+@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
+
+@c
+@c
+@c
+@page
+@subsection pthread_key_delete - Delete Thread Specific Data Key
+
+@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:
+
+@c
+@c
+@c
+@page
+@subsection pthread_setspecific - Set Thread Specific Key Value
+
+@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:
+
+@c
+@c
+@c
+@page
+@subsection pthread_getspecific - Get Thread Specific Key Value
+
+@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:
+