Man page - upscli_upserror(3)

Packages contains this manual

Package:  libupsclient-dev
apt-get install libupsclient-dev

Manuals in package:
• upscli_cleanup(3)
• upscli_list_next(3)
• upscli_fd(3)
• upscli_list_start(3)
• upscli_splitname(3)
• upsclient(3)
• upscli_sendline(3)
• upscli_init(3)
• upscli_upserror(3)
• upscli_connect(3)
• upscli_add_host_cert(3)
• upscli_sendline_timeout(3)
• upscli_splitaddr(3)
• upscli_ssl(3)
• upscli_disconnect(3)
• upscli_readline(3)
• upscli_strerror(3)
• upscli_get(3)
• upscli_readline_timeout(3)
Documentations in package:
• libupsclient-dev

Manual

UPSCLI_UPSERROR

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
SEE ALSO

---

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 upsd (8) which might not support a given command.

Some error messages have additional meanings, so you should use 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

upscli_readline (3), upscli_sendline (3), upscli_strerror (3)

---