NAME
upscli_getlist − retrieve a variable list from a UPS
SYNOPSIS
#include <upsclient.h>
int upscli_getlist(UPSCONN *ups, const char *upsname,
|
int listtype, char *buf, size_t buflen); |
DESCRIPTION
The upscli_getlist() function takes the pointer ups to a UPSCONN state structure and generates a request for a list of type listtype on the UPS called upsname.
The listtype may be one of the following values:
UPSCLI_LIST_VARS
- all variables ("LISTVARS")
UPSCLI_LIST_RW - only read/write variables
("LISTRW")
UPSCLI_LIST_CMDS - instant commands
("LISTINSTCMDS")
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 and command names like OFF. To use new names like ups.status or load.off, use upscli_list_start(3) and upscli_list_next(3).
RETURN VALUE
The upscli_getlist() function returns 0 on success, or -1 if an error occurs.