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
15 operation. Its only argument is a remctl struct as returned by
16 remctl_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
21 memory fault. The returned pointer will be invalidated by the next
22 call to any remctl API function with the same client object, other than
23 remctl_error().
24
26 remctl_error() returns either the previous error or the constant string
27 "No error". It will never return NULL.
28
30 This interface has been provided by the remctl client library since its
31 initial release in version 2.0.
32
34 Russ Allbery <eagle@eyrie.org>
35
37 Copyright 2007, 2009, 2014 The Board of Trustees of the Leland Stanford
38 Junior University
39
40 Copying and distribution of this file, with or without modification,
41 are permitted in any medium without royalty provided the copyright
42 notice and this notice are preserved. This file is offered as-is,
43 without any warranty.
44
45 SPDX-License-Identifier: FSFAP
46
48 remctl_new(3), remctl_open(3), remctl_command(3), remctl_commandv(3),
49 remctl_output(3)
50
51 The current version of the remctl library and complete details of the
52 remctl protocol are available from its web page at
53 <https://www.eyrie.org/~eagle/software/remctl/>.
54
55
56
573.18 2022-05-09 REMCTL_ERROR(3)