Imported Upstream version 2.6.0
This commit is contained in:
parent
26fb71b504
commit
459aaf9392
510 changed files with 40508 additions and 18859 deletions
40
docs/man/upscli_upserror.txt
Normal file
40
docs/man/upscli_upserror.txt
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
UPSCLI_UPSERROR(3)
|
||||
==================
|
||||
|
||||
NAME
|
||||
----
|
||||
|
||||
upscli_upserror - Get current error number for connection
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
|
||||
#include <upsclient.h>
|
||||
|
||||
int upscli_upserror(UPSCONN_t *ups);
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
The *upscli_upserror*() function takes the pointer 'ups' to a
|
||||
`UPSCONN_t` state structure and returns the value of the internal error
|
||||
number, if any.
|
||||
|
||||
This is typically used to check for certain error values like
|
||||
`UPSCLI_ERR_UNKCOMMAND`. That specific error can be used for detecting
|
||||
older versions of linkman:upsd[8] which might not support a given command.
|
||||
|
||||
Some error messages have additional meanings, so you should use
|
||||
linkman:upscli_strerror[3] to obtain readable error messages.
|
||||
|
||||
RETURN VALUE
|
||||
------------
|
||||
|
||||
The *upscli_upserror*() function returns one of the `UPSCLI_ERR_*`
|
||||
values from `upsclient.h`, or 0 if no error has occurred.
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
|
||||
linkman:upscli_readline[3], linkman:upscli_sendline[3],
|
||||
linkman:upscli_strerror[3]
|
||||
Loading…
Add table
Add a link
Reference in a new issue