1explain_mkdtemp(3) Library Functions Manual explain_mkdtemp(3)
2
6 explain_mkdtemp - explain mkdtemp(3) errors
7
9 #include <libexplain/mkdtemp.h>
10 const char *explain_mkdtemp(char *pathname);
11 const char *explain_errno_mkdtemp(int errnum, char *pathname);
12 void explain_message_mkdtemp(char *message, int message_size, char
13 *pathname);
14 void explain_message_errno_mkdtemp(char *message, int message_size, int
15 errnum, char *pathname);
16
18 These functions may be used to obtain explanations for errors returned
19 by the mkdtemp(3) system call.
20 explain_mkdtemp
22 const char *explain_mkdtemp(char *pathname);
23 The explain_mkdtemp function is used to obtain an explanation of an
25 error returned by the mkdtemp(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 pathname
33 The original pathname, exactly as passed to the mkdtemp(3) sys‐
34 tem call.
35 Returns:
37 The message explaining the error. This message buffer is shared
38 by all libexplain functions which do not supply a buffer in
39 their argument list. This will be overwritten by the next call
40 to any libexplain function which shares this buffer, including
41 other threads.
42 Note: This function is not thread safe, because it shares a return buf‐
44 fer across all threads, and many other functions in this library.
45 Example: This function is intended to be used in a fashion similar to
47 the following example:
48 char *result = mkdtemp(pathname);
49 if (!result)
50 {
51 fprintf(stderr, "%s\n", explain_mkdtemp(pathname));
52 exit(EXIT_FAILURE);
53 }
54 The above code example is available pre‐packaged as the
56 explain_mkdtemp_or_die(3) function.
57 explain_errno_mkdtemp
59 const char *explain_errno_mkdtemp(int errnum, char *pathname);
60 The explain_errno_mkdtemp function is used to obtain an explanation of
62 an error returned by the mkdtemp(3) system call. The least the message
63 will contain is the value of strerror(errno), but usually it will do
64 much better, and indicate the underlying cause in more detail.
65 errnum The error value to be decoded, usually obtained from the errno
67 global variable just before this function is called. This is
68 necessary if you need to call any code between the system call
69 to be explained and this function, because many libc functions
70 will alter the value of errno.
71 pathname
73 The original pathname, exactly as passed to the mkdtemp(3) sys‐
74 tem call.
75 Returns:
77 The message explaining the error. This message buffer is shared
78 by all libexplain functions which do not supply a buffer in
79 their argument list. This will be overwritten by the next call
80 to any libexplain function which shares this buffer, including
81 other threads.
82 Note: This function is not thread safe, because it shares a return buf‐
84 fer across all threads, and many other functions in this library.
85 Example: This function is intended to be used in a fashion similar to
87 the following example:
88 char *result = mkdtemp(pathname);
89 if (!result)
90 {
91 int err = errno;
92 fprintf(stderr, "%s\n", explain_errno_mkdtemp(err, path‐
93 name));
94 exit(EXIT_FAILURE);
95 }
96 The above code example is available pre‐packaged as the
98 explain_mkdtemp_or_die(3) function.
99 explain_message_mkdtemp
101 void explain_message_mkdtemp(char *message, int message_size, char
102 *pathname);
103 The explain_message_mkdtemp function is used to obtain an explanation
105 of an error returned by the mkdtemp(3) system call. The least the mes‐
106 sage will contain is the value of strerror(errno), but usually it will
107 do much better, and indicate the underlying cause in more detail.
108 The errno global variable will be used to obtain the error value to be
110 decoded.
111 message The location in which to store the returned message. If a suit‐
113 able message return buffer is supplied, this function is thread
114 safe.
115 message_size
117 The size in bytes of the location in which to store the
118 returned message.
119 pathname
121 The original pathname, exactly as passed to the mkdtemp(3) sys‐
122 tem call.
123 Example: This function is intended to be used in a fashion similar to
125 the following example:
126 char *result = mkdtemp(pathname);
127 if (!result)
128 {
129 char message[3000];
130 explain_message_mkdtemp(message, sizeof(message), pathname);
131 fprintf(stderr, "%s\n", message);
132 exit(EXIT_FAILURE);
133 }
134 The above code example is available pre‐packaged as the
136 explain_mkdtemp_or_die(3) function.
137 explain_message_errno_mkdtemp
139 void explain_message_errno_mkdtemp(char *message, int message_size, int
140 errnum, char *pathname);
141 The explain_message_errno_mkdtemp function is used to obtain an expla‐
143 nation of an error returned by the mkdtemp(3) system call. The least
144 the message will contain is the value of strerror(errno), but usually
145 it will do much better, and indicate the underlying cause in more
146 detail.
147 message The location in which to store the returned message. If a suit‐
149 able message return buffer is supplied, this function is thread
150 safe.
151 message_size
153 The size in bytes of the location in which to store the
154 returned message.
155 errnum The error value to be decoded, usually obtained from the errno
157 global variable just before this function is called. This is
158 necessary if you need to call any code between the system call
159 to be explained and this function, because many libc functions
160 will alter the value of errno.
161 pathname
163 The original pathname, exactly as passed to the mkdtemp(3) sys‐
164 tem call.
165 Example: This function is intended to be used in a fashion similar to
167 the following example:
168 char *result = mkdtemp(pathname);
169 if (!result)
170 {
171 int err = errno;
172 char message[3000];
173 explain_message_errno_mkdtemp(message, sizeof(message), err,
174 pathname);
175 fprintf(stderr, "%s\n", message);
176 exit(EXIT_FAILURE);
177 }
178 The above code example is available pre‐packaged as the
180 explain_mkdtemp_or_die(3) function.
181
183 mkdtemp(3)
184 create a unique temporary directory
185 explain_mkdtemp_or_die(3)
187 create a unique temporary directory and report errors
188
190 libexplain version 1.4
191 Copyright (C) 2009 Peter Miller
192 explain_mkdtemp(3)