Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

remctl_error(3) [debian man page]

REMCTL_ERROR(3) 					     remctl Library Reference						   REMCTL_ERROR(3)

NAME

       remctl_error - Retrieve the error from a failed remctl operation

SYNOPSIS

       #include <remctl.h>

       const char *remctl_error(struct remctl *r);

DESCRIPTION

       remctl_error() returns the error from a previously failed remctl operation.  Its only argument is a remctl struct as returned by
       remctl_new().  If the previous remctl operation was successful, returns the constant string "No error".

       The caller may not modify the returned string.  The string may even be stored in read-only memory and attempting to modify it may cause a
       memory fault.  The returned pointer will be invalidated by the next call to any remctl API function with the same client object, other than
       remctl_error().

RETURN VALUE

       remctl_error() returns either the previous error or the constant string "No error".  It will never return NULL.

SEE ALSO

       remctl_new(3), remctl_open(3), remctl_command(3), remctl_commandv(3), remctl_output(3)

       The current version of the remctl library and complete details of the remctl protocol are available from its web page at
       <http://www.eyrie.org/~eagle/software/remctl/>.

AUTHOR

       Russ Allbery <rra@stanford.edu>

COPYRIGHT AND LICENSE

       Copyright 2007, 2009 The Board of Trustees of the Leland Stanford Junior University

       Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright
       notice and this notice are preserved.  This file is offered as-is, without any warranty.

3.2								    2012-06-19							   REMCTL_ERROR(3)

Check Out this Related Man Page

REMCTL_CLOSE(3) 					     remctl Library Reference						   REMCTL_CLOSE(3)

NAME

       remctl_close - Close a remctl connection and free the client object

SYNOPSIS

       #include <remctl.h>

       void remctl_close(struct remctl *r);

DESCRIPTION

       remctl_close() cleanly closes any connection to a remote server created via remctl_open() for the given client object and then frees the
       object created by remctl_new().	It should be called when the caller is finished with a remctl client object to avoid resource leaks.
       Following the call to remctl_close(), the r pointer to the remctl client object is no longer valid.

       remctl_close() is always successful, even if it is unable to send a clean protocol quit command to the remote server.

SEE ALSO

       remctl_new(3), remctl_open(3)

       The current version of the remctl library and complete details of the remctl protocol are available from its web page at
       <http://www.eyrie.org/~eagle/software/remctl/>.

AUTHOR

       Russ Allbery <rra@stanford.edu>

COPYRIGHT AND LICENSE

       Copyright 2007, 2009 The Board of Trustees of the Leland Stanford Junior University

       Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright
       notice and this notice are preserved.  This file is offered as-is, without any warranty.

3.2								    2012-06-19							   REMCTL_CLOSE(3)
Man Page