source: rtems/doc/posix_users/key.t @ c4dddee

4.104.114.84.95
Last change on this file since c4dddee was c4dddee, checked in by Joel Sherrill <joel.sherrill@…>, on Nov 19, 1998 at 4:06:46 PM

Major update/merge of POSIX manual.

  • Property mode set to 100644
File size: 2.1 KB
Line 
1@c
2@c  COPYRIGHT (c) 1988-1998.
3@c  On-Line Applications Research Corporation (OAR).
4@c  All rights reserved.
5@c
6@c  $Id$
7@c
8
9@chapter Key Manager
10
11@section Introduction
12
13The key manager ...
14
15The directives provided by the key manager are:
16
17@itemize @bullet
18@item @code{pthread_key_create} -
19@item @code{pthread_key_delete} -
20@item @code{pthread_setspecific} -
21@item @code{pthread_getspecific} -
22@end itemize
23
24@section Background
25
26There is currently no text in this section.
27
28@section Operations
29
30There is currently no text in this section.
31
32@section Directives
33
34This section details the key manager's directives.
35A subsection is dedicated to each of this manager's directives
36and describes the calling sequence, related constants, usage,
37and status codes.
38
39@page
40@subsection pthread_key_create
41
42@subheading CALLING SEQUENCE:
43
44@example
45#include <pthread.h>
46
47int pthread_key_create(
48  pthread_key_t  *key,
49  void          (*destructor)( void * )
50);
51@end example
52
53@subheading STATUS CODES:
54
55@table @b
56@item EAGAIN
57There were not enough resources available to create another key.
58
59@item ENOMEM
60Insufficient memory exists to create the key.
61
62@end table
63
64@page
65@subsection pthread_key_delete
66 
67@subheading CALLING SEQUENCE:
68 
69@example
70#include <pthread.h>
71 
72int pthread_key_delete(
73  pthread_key_t  key,
74);
75@end example
76 
77@subheading STATUS CODES:
78 
79@table @b
80@item EINVAL
81The key was invalid
82 
83@end table
84
85@subheading DESCRIPTION:
86
87@subheading NOTES:
88
89@page
90@subsection pthread_setspecific
91
92@subheading CALLING SEQUENCE:
93
94@example
95#include <pthread.h>
96
97int pthread_setspecific(
98  pthread_key_t  key,
99  const void    *value
100);
101@end example
102
103@subheading STATUS CODES:
104@table @b
105@item EINVAL
106The specified key is invalid.
107
108@end table
109
110@subheading DESCRIPTION:
111
112@subheading NOTES:
113
114@page
115@subsection pthread_getspecific
116
117@subheading CALLING SEQUENCE:
118
119@example
120#include <pthread.h>
121
122void *pthread_getspecific(
123  pthread_key_t  key
124);
125@end example
126
127@subheading STATUS CODES:
128@table @b
129@item NULL
130There is no thread-specific data associated with the specified key.
131
132@item non-NULL
133The data associated with the specified key.
134
135@end table
136
137@subheading DESCRIPTION:
138
139@subheading NOTES:
140
Note: See TracBrowser for help on using the repository browser.