NAME

upscli_upserror - Get current error number for connection

SYNOPSIS

Note
Two NUT websites

This version of the page reflects NUT release v2.8.1 with codebase commited 4ba352d8f at 2023-10-31T21:46:20+01:00

Options, features and capabilities in current development (and future releases) are detailed on the main site and may differ from ones described here.

#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