1REMCTL_ERROR(3) remctl Library Reference REMCTL_ERROR(3)
2
3
4
6 remctl_error - Retrieve the error from a failed remctl operation
7
9 #include <remctl.h>
10
11 const char *remctl_error(struct remctl *r);
12
14 remctl_error() returns the error from a previously failed remctl opera‐
15 tion. Its only argument is a remctl struct as returned by rem‐
16 ctl_new(). If the previous remctl operation was successful, returns
17 the constant string "No error".
18
19 The caller may not modify the returned string. The string may even be
20 stored in read-only memory and attempting to modify it may cause a mem‐
21 ory fault. The returned pointer will be invalidated by the next call
22 to any remctl API function with the same client object, other than rem‐
23 ctl_error().
24
26 remctl_error() returns either the previous error or the constant string
27 "No error". It will never return NULL.
28
30 remctl_new(3), remctl_open(3), remctl_command(3), remctl_commandv(3),
31 remctl_output(3)
32
33 The current version of the remctl library and complete details of the
34 remctl protocol are available from its web page at
35 <http://www.eyrie.org/~eagle/software/remctl/>.
36
38 Russ Allbery <rra@stanford.edu>
39
40
41
422.11 2007-06-29 REMCTL_ERROR(3)