1explain_mkstemp(3) Library Functions Manual explain_mkstemp(3)
2
6 explain_mkstemp - explain mkstemp(3) errors
7
9 #include <libexplain/mkstemp.h>
10 const char *explain_mkstemp(char *templat);
11 const char *explain_errno_mkstemp(int errnum, char *templat);
12 void explain_message_mkstemp(char *message, int message_size, char
13 *templat);
14 void explain_message_errno_mkstemp(char *message, int message_size, int
15 errnum, char *templat);
16
18 These functions may be used to obtain explanations for errors returned
19 by the mkstemp(3) system call.
20 explain_mkstemp
22 const char *explain_mkstemp(char *templat);
23 The explain_mkstemp function is used to obtain an explanation of an
25 error returned by the mkstemp(3) system call. The least the message
26 will contain is the value of strerror(errno), but usually it will do
27 much better, and indicate the underlying cause in more detail.
28 The errno global variable will be used to obtain the error value to be
30 decoded.
31 templat The original template, exactly as passed to the mkstemp(3) sys‐
33 tem call.
34 Returns:
36 The message explaining the error. This message buffer is shared
37 by all libexplain functions which do not supply a buffer in
38 their argument list. This will be overwritten by the next call
39 to any libexplain function which shares this buffer, including
40 other threads.
41 Note: This function is not thread safe, because it shares a return buf‐
43 fer across all threads, and many other functions in this library.
44 Example: This function is intended to be used in a fashion similar to
46 the following example:
47 int result = mkstemp(templat);
48 if (result < 0)
49 {
50 fprintf(stderr, "%s\n", explain_mkstemp(templat));
51 exit(EXIT_FAILURE);
52 }
53 The above code example is available pre‐packaged as the
55 explain_mkstemp_or_die(3) function.
56 explain_errno_mkstemp
58 const char *explain_errno_mkstemp(int errnum, char *templat);
59 The explain_errno_mkstemp function is used to obtain an explanation of
61 an error returned by the mkstemp(3) system call. The least the message
62 will contain is the value of strerror(errno), but usually it will do
63 much better, and indicate the underlying cause in more detail.
64 errnum The error value to be decoded, usually obtained from the errno
66 global variable just before this function is called. This is
67 necessary if you need to call any code between the system call
68 to be explained and this function, because many libc functions
69 will alter the value of errno.
70 templat The original template, exactly as passed to the mkstemp(3) sys‐
72 tem call.
73 Returns:
75 The message explaining the error. This message buffer is shared
76 by all libexplain functions which do not supply a buffer in
77 their argument list. This will be overwritten by the next call
78 to any libexplain function which shares this buffer, including
79 other threads.
80 Note: This function is not thread safe, because it shares a return buf‐
82 fer across all threads, and many other functions in this library.
83 Example: This function is intended to be used in a fashion similar to
85 the following example:
86 int result = mkstemp(templat);
87 if (result < 0)
88 {
89 int err = errno;
90 fprintf(stderr, "%s\n", explain_errno_mkstemp(err, tem‐
91 plat));
92 exit(EXIT_FAILURE);
93 }
94 The above code example is available pre‐packaged as the
96 explain_mkstemp_or_die(3) function.
97 explain_message_mkstemp
99 void explain_message_mkstemp(char *message, int message_size, char
100 *templat);
101 The explain_message_mkstemp function is used to obtain an explanation
103 of an error returned by the mkstemp(3) system call. The least the mes‐
104 sage will contain is the value of strerror(errno), but usually it will
105 do much better, and indicate the underlying cause in more detail.
106 The errno global variable will be used to obtain the error value to be
108 decoded.
109 message The location in which to store the returned message. If a suit‐
111 able message return buffer is supplied, this function is thread
112 safe.
113 message_size
115 The size in bytes of the location in which to store the
116 returned message.
117 templat The original template, exactly as passed to the mkstemp(3) sys‐
119 tem call.
120 Example: This function is intended to be used in a fashion similar to
122 the following example:
123 int result = mkstemp(templat);
124 if (result < 0)
125 {
126 char message[3000];
127 explain_message_mkstemp(message, sizeof(message), templat);
128 fprintf(stderr, "%s\n", message);
129 exit(EXIT_FAILURE);
130 }
131 The above code example is available pre‐packaged as the
133 explain_mkstemp_or_die(3) function.
134 explain_message_errno_mkstemp
136 void explain_message_errno_mkstemp(char *message, int message_size, int
137 errnum, char *templat);
138 The explain_message_errno_mkstemp function is used to obtain an expla‐
140 nation of an error returned by the mkstemp(3) system call. The least
141 the message will contain is the value of strerror(errno), but usually
142 it will do much better, and indicate the underlying cause in more
143 detail.
144 message The location in which to store the returned message. If a suit‐
146 able message return buffer is supplied, this function is thread
147 safe.
148 message_size
150 The size in bytes of the location in which to store the
151 returned message.
152 errnum The error value to be decoded, usually obtained from the errno
154 global variable just before this function is called. This is
155 necessary if you need to call any code between the system call
156 to be explained and this function, because many libc functions
157 will alter the value of errno.
158 templat The original template, exactly as passed to the mkstemp(3) sys‐
160 tem call.
161 Example: This function is intended to be used in a fashion similar to
163 the following example:
164 int result = mkstemp(templat);
165 if (result < 0)
166 {
167 int err = errno;
168 char message[3000];
169 explain_message_errno_mkstemp(message, sizeof(message), err,
170 templat);
171 fprintf(stderr, "%s\n", message);
172 exit(EXIT_FAILURE);
173 }
174 The above code example is available pre‐packaged as the
176 explain_mkstemp_or_die(3) function.
177
179 mkstemp(3)
180 create a unique temporary file
181 explain_mkstemp_or_die(3)
183 create a unique temporary file and report errors
184
186 libexplain version 1.4
187 Copyright (C) 2009 Peter Miller
188 explain_mkstemp(3)