1explain_getresuid(3) Library Functions Manual explain_getresuid(3)
2
6 explain_getresuid - explain getresuid(2) errors
7
9 #include <libexplain/getresuid.h>
10 const char *explain_getresuid(uid_t *ruid, uid_t *euid, uid_t *suid);
11 const char *explain_errno_getresuid(int errnum, uid_t *ruid, uid_t
12 *euid, uid_t *suid);
13 void explain_message_getresuid(char *message, int message_size, uid_t
14 *ruid, uid_t *euid, uid_t *suid);
15 void explain_message_errno_getresuid(char *message, int message_size,
16 int errnum, uid_t *ruid, uid_t *euid, uid_t *suid);
17
19 These functions may be used to obtain explanations for errors returned
20 by the getresuid(2) system call.
21 explain_getresuid
23 const char *explain_getresuid(uid_t *ruid, uid_t *euid, uid_t *suid);
24 The explain_getresuid function is used to obtain an explanation of an
26 error returned by the getresuid(2) system call. The least the message
27 will contain is the value of strerror(errno), but usually it will do
28 much better, and indicate the underlying cause in more detail.
29 The errno global variable will be used to obtain the error value to be
31 decoded.
32 ruid The original ruid, exactly as passed to the getresuid(2) system
34 call.
35 euid The original euid, exactly as passed to the getresuid(2) system
37 call.
38 suid The original suid, exactly as passed to the getresuid(2) system
40 call.
41 Returns:
43 The message explaining the error. This message buffer is shared
44 by all libexplain functions which do not supply a buffer in
45 their argument list. This will be overwritten by the next call
46 to any libexplain function which shares this buffer, including
47 other threads.
48 Note: This function is not thread safe, because it shares a return buf‐
50 fer across all threads, and many other functions in this library.
51 Example: This function is intended to be used in a fashion similar to
53 the following example:
54 if (getresuid(ruid, euid, suid) < 0)
55 {
56 fprintf(stderr, "%s\n", explain_getresuid(ruid, euid,
57 suid));
58 exit(EXIT_FAILURE);
59 }
60 The above code example is available pre-packaged as the explain_getre‐
62 suid_or_die(3) function.
63 explain_errno_getresuid
65 const char *explain_errno_getresuid(int errnum, uid_t *ruid, uid_t
66 *euid, uid_t *suid);
67 The explain_errno_getresuid function is used to obtain an explanation
69 of an error returned by the getresuid(2) system call. The least the
70 message will contain is the value of strerror(errno), but usually it
71 will do much better, and indicate the underlying cause in more detail.
72 errnum The error value to be decoded, usually obtained from the errno
74 global variable just before this function is called. This is
75 necessary if you need to call any code between the system call
76 to be explained and this function, because many libc functions
77 will alter the value of errno.
78 ruid The original ruid, exactly as passed to the getresuid(2) system
80 call.
81 euid The original euid, exactly as passed to the getresuid(2) system
83 call.
84 suid The original suid, exactly as passed to the getresuid(2) system
86 call.
87 Returns:
89 The message explaining the error. This message buffer is shared
90 by all libexplain functions which do not supply a buffer in
91 their argument list. This will be overwritten by the next call
92 to any libexplain function which shares this buffer, including
93 other threads.
94 Note: This function is not thread safe, because it shares a return buf‐
96 fer across all threads, and many other functions in this library.
97 Example: This function is intended to be used in a fashion similar to
99 the following example:
100 if (getresuid(ruid, euid, suid) < 0)
101 {
102 int err = errno;
103 fprintf(stderr, "%s\n", explain_errno_getresuid(err, ruid,
104 euid, suid));
105 exit(EXIT_FAILURE);
106 }
107 The above code example is available pre-packaged as the explain_getre‐
109 suid_or_die(3) function.
110 explain_message_getresuid
112 void explain_message_getresuid(char *message, int message_size, uid_t
113 *ruid, uid_t *euid, uid_t *suid);
114 The explain_message_getresuid function is used to obtain an explanation
116 of an error returned by the getresuid(2) system call. The least the
117 message will contain is the value of strerror(errno), but usually it
118 will do much better, and indicate the underlying cause in more detail.
119 The errno global variable will be used to obtain the error value to be
121 decoded.
122 message The location in which to store the returned message. If a suit‐
124 able message return buffer is supplied, this function is thread
125 safe.
126 message_size
128 The size in bytes of the location in which to store the
129 returned message.
130 ruid The original ruid, exactly as passed to the getresuid(2) system
132 call.
133 euid The original euid, exactly as passed to the getresuid(2) system
135 call.
136 suid The original suid, exactly as passed to the getresuid(2) system
138 call.
139 Example: This function is intended to be used in a fashion similar to
141 the following example:
142 if (getresuid(ruid, euid, suid) < 0)
143 {
144 char message[3000];
145 explain_message_getresuid(message, sizeof(message), ruid,
146 euid, suid);
147 fprintf(stderr, "%s\n", message);
148 exit(EXIT_FAILURE);
149 }
150 The above code example is available pre-packaged as the explain_getre‐
152 suid_or_die(3) function.
153 explain_message_errno_getresuid
155 void explain_message_errno_getresuid(char *message, int message_size,
156 int errnum, uid_t *ruid, uid_t *euid, uid_t *suid);
157 The explain_message_errno_getresuid function is used to obtain an
159 explanation of an error returned by the getresuid(2) system call. The
160 least the message will contain is the value of strerror(errno), but
161 usually it will do much better, and indicate the underlying cause in
162 more detail.
163 message The location in which to store the returned message. If a suit‐
165 able message return buffer is supplied, this function is thread
166 safe.
167 message_size
169 The size in bytes of the location in which to store the
170 returned message.
171 errnum The error value to be decoded, usually obtained from the errno
173 global variable just before this function is called. This is
174 necessary if you need to call any code between the system call
175 to be explained and this function, because many libc functions
176 will alter the value of errno.
177 ruid The original ruid, exactly as passed to the getresuid(2) system
179 call.
180 euid The original euid, exactly as passed to the getresuid(2) system
182 call.
183 suid The original suid, exactly as passed to the getresuid(2) system
185 call.
186 Example: This function is intended to be used in a fashion similar to
188 the following example:
189 if (getresuid(ruid, euid, suid) < 0)
190 {
191 int err = errno;
192 char message[3000];
193 explain_message_errno_getresuid(message, sizeof(message),
194 err, ruid, euid, suid);
195 fprintf(stderr, "%s\n", message);
196 exit(EXIT_FAILURE);
197 }
198 The above code example is available pre-packaged as the explain_getre‐
200 suid_or_die(3) function.
201
203 getresuid(2)
204 get real, effective and saved user IDs
205 explain_getresuid_or_die(3)
207 get real, effective and saved user IDs and report errors
208
210 libexplain version 1.4
211 Copyright (C) 2012 Peter Miller
212 explain_getresuid(3)