web
Last change
on this file since f6f3e91 was
f6f3e91,
checked in by Jessica B. Hamrick <jhamrick@…>, 15 years ago
|
Preserve directory hierarchy (not sure what happened to it)
|
-
Property mode set to
100644
|
File size:
1.2 KB
|
Line | |
---|
1 | =for stopwords |
---|
2 | remctl const API Allbery |
---|
3 | |
---|
4 | =head1 NAME |
---|
5 | |
---|
6 | remctl_error - Retrieve the error from a failed remctl operation |
---|
7 | |
---|
8 | =head1 SYNOPSIS |
---|
9 | |
---|
10 | #include <remctl.h> |
---|
11 | |
---|
12 | const char *B<remctl_error>(struct remctl *I<r>); |
---|
13 | |
---|
14 | =head1 DESCRIPTION |
---|
15 | |
---|
16 | remctl_error() returns the error from a previously failed remctl |
---|
17 | operation. Its only argument is a remctl struct as returned by |
---|
18 | remctl_new(). If the previous remctl operation was successful, returns |
---|
19 | the constant string "No error". |
---|
20 | |
---|
21 | The caller may not modify the returned string. The string may even be |
---|
22 | stored in read-only memory and attempting to modify it may cause a memory |
---|
23 | fault. The returned pointer will be invalidated by the next call to any |
---|
24 | remctl API function with the same client object, other than |
---|
25 | remctl_error(). |
---|
26 | |
---|
27 | =head1 RETURN VALUE |
---|
28 | |
---|
29 | remctl_error() returns either the previous error or the constant string |
---|
30 | "No error". It will never return NULL. |
---|
31 | |
---|
32 | =head1 SEE ALSO |
---|
33 | |
---|
34 | remctl_new(3), remctl_open(3), remctl_command(3), remctl_commandv(3), |
---|
35 | remctl_output(3) |
---|
36 | |
---|
37 | The current version of the remctl library and complete details of the |
---|
38 | remctl protocol are available from its web page at |
---|
39 | L<http://www.eyrie.org/~eagle/software/remctl/>. |
---|
40 | |
---|
41 | =head1 AUTHOR |
---|
42 | |
---|
43 | Russ Allbery <rra@stanford.edu> |
---|
44 | |
---|
45 | =cut |
---|
Note: See
TracBrowser
for help on using the repository browser.