Manpages

NAME

upscli_getvar − retrieve a variable from a UPS

SYNOPSIS

#include <upsclient.h>

int upscli_getvar(UPSCONN *ups, const char *upsname,

const char *var, char *buf, size_t buflen);

DESCRIPTION

The upscli_getvar() function takes the pointer ups to a UPSCONN state structure and generates a request for the variable var on the UPS called upsname.

Upon success, up to buflen bytes of the response will be copied into the character array buf.

OLD FUNCTION

This function is provided for compatibility with older versions of upsd and will be removed at some point in the future. It also only operates with older variable names like STATUS. To use new names like ups.status, use upscli_get(3) instead.

RETURN VALUE

The upscli_getvar() function returns 0 on success, or -1 if an error occurs.

SEE ALSO

upscli_getlist(3), upscli_strerror(3), upscli_upserror(3)