Man page - nutclient_get_device_variables(3)

Packages contains this manual

Package:  libnutclient-dev
apt-get install libnutclient-dev

Manuals in package:
• nutclient_get_device_description(3)
• nutclient_get_device_num_logins(3)
• nutclient_set_device_variable_values(3)
• nutclient_tcp_create_client(3)
• nutclient_tcp_set_timeout(3)
• nutclient_set_device_variable_value(3)
• libnutclient_general(3)
• nutclient_get_device_commands(3)
• libnutclient_misc(3)
• nutclient_get_devices(3)
• nutclient_logout(3)
• nutclient_device_login(3)
• libnutclient_tcp(3)
• nutclient_tcp_disconnect(3)
• libnutclient_variables(3)
• nutclient_get_device_variable_values(3)
• nutclient_authenticate(3)
• nutclient_device_forced_shutdown(3)
• nutclient_destroy(3)
• nutclient_has_device_command(3)
• nutclient_get_device_variable_description(3)
• nutclient_get_device_command_description(3)
• nutclient_has_device_variable(3)
• nutclient_tcp_reconnect(3)
• nutclient_device_master(3)
• nutclient_execute_device_command(3)
• nutclient_get_device_rw_variables(3)
• libnutclient(3)
• nutclient_has_device(3)
• nutclient_get_device_variables(3)
• libnutclient_devices(3)
• libnutclient_commands(3)
• nutclient_tcp_is_connected(3)
• nutclient_tcp_get_timeout(3)
Documentations in package:
• libnutclient-dev

Manual

LIBNUTCLIENT_VARIABL

NAME
SYNOPSIS
DESCRIPTION
SEE ALSO

---

NAME

libnutclient_variables, nutclient_get_device_variables, nutclient_get_device_rw_variables, nutclient_has_device_variable, nutclient_get_device_variable_description, nutclient_get_device_variable_values, nutclient_set_device_variable_value, nutclient_set_device_variable_values - Variable related functions in Network UPS Tools high-level client access library

SYNOPSIS

#include <nutclient.h>

typedef void* NUTCLIENT_t;

typedef char** strarr;

strarr nutclient_get_device_variables(NUTCLIENT_t client,
const char* dev);

strarr nutclient_get_device_rw_variables(NUTCLIENT_t client,
const char* dev);

int nutclient_has_device_variable(NUTCLIENT_t client,
const char* dev, const char* var);

char* nutclient_get_device_variable_description(NUTCLIENT_t client,
const char* dev, const char* var);

strarr nutclient_get_device_variable_values(NUTCLIENT_t client,
const char* dev, const char* var);

void nutclient_set_device_variable_value(NUTCLIENT_t client,
const char* dev, const char* var, const char* value);

void nutclient_set_device_variable_values(NUTCLIENT_t client,
const char* dev, const char* var, const strarr values);

DESCRIPTION

These functions allow to manage variables of devices.

The nutclient_get_device_variables() function retrieves the list of variables names for a device. The returned strarr must be freed by strarr_free .

The nutclient_get_device_rw_variables function retrieves the list of read-write variables names for a device. The returned strarr must be freed by strarr_free .

The nutclient_has_device_variable function tests if the specified variable is supported by the device. Return 1 is supported and 0 if not.

The nutclient_get_device_variable_description function retrieves the variable description, if any. The returned string must be freed.

The nutclient_get_device_variable_values returns variable values (generally only one). The returned strarr must be freed by strarr_free .

The nutclient_set_device_variable_value intends to set the value of the specified variable.

The nutclient_set_device_variable_values intends to set multiple values of the specified variable.

Common arguments:

• dev is the device name.

• var is the variable name.

• value is the variable value.

• values is the variable array of values.

SEE ALSO

libnutclient (3) libnutclient_devices (3) libnutclient_general (3)

---