File: upscli_upserror.txt

package info (click to toggle)
nut 2.7.4-8
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 10,964 kB
  • sloc: ansic: 70,278; sh: 12,814; python: 2,202; cpp: 1,715; makefile: 1,406; perl: 705; xml: 40
file content (40 lines) | stat: -rw-r--r-- 961 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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]