1LIBNUTCLIENT_VARIABL(3)           NUT Manual           LIBNUTCLIENT_VARIABL(3)
2
3
4

NAME

6       libnutclient_variables, nutclient_get_device_variables,
7       nutclient_get_device_rw_variables, nutclient_has_device_variable,
8       nutclient_get_device_variable_description,
9       nutclient_get_device_variable_values,
10       nutclient_set_device_variable_value,
11       nutclient_set_device_variable_values - Variable related functions in
12       Network UPS Tools high-level client access library
13

SYNOPSIS

15       #include <nutclient.h>
16
17       typedef void* NUTCLIENT_t;
18
19       strarr nutclient_get_device_variables(NUTCLIENT_t client, const char* dev);
20       strarr nutclient_get_device_rw_variables(NUTCLIENT_t client, const char* dev);
21       int nutclient_has_device_variable(NUTCLIENT_t client, const char* dev, const char* var);
22       char* nutclient_get_device_variable_description(NUTCLIENT_t client, const char* dev, const char* var);
23       strarr nutclient_get_device_variable_values(NUTCLIENT_t client, const char* dev, const char* var);
24       void nutclient_set_device_variable_value(NUTCLIENT_t client, const char* dev, const char* var, const char* value);
25       void nutclient_set_device_variable_values(NUTCLIENT_t client, const char* dev, const char* var, const strarr values);
26

DESCRIPTION

28       These functions allow to manage variables of devices.
29
30       The nutclient_get_device_variables() function retrieve the list of
31       variables names for a device. The returned strarr must be freed by
32       strarr_free.
33
34       The nutclient_get_device_rw_variables function retrieve the list of
35       read-write variables names for a device. The returned strarr must be
36       freed by strarr_free.
37
38       The nutclient_has_device_variable function test if the specified
39       variable is supported by the device. Return 1 is supported and 0 if
40       not.
41
42       The nutclient_get_device_variable_description function retrieve the
43       variable description, if any. The resturned string must be freed.
44
45       The nutclient_get_device_variable_values returns variable values
46       (generally only one). The returned strarr must be freed by strarr_free.
47
48       The nutclient_set_device_variable_value intend to set the value of the
49       specified variable.
50
51       The nutclient_set_device_variable_values intend to set multiple values
52       of the specified variable.
53
54       dev is the device name.
55
56       var is the variable name.
57
58       value is the variable value.
59
60       values is the variable array of values.
61

SEE ALSO

63       libnutclient(3) libnutclient_devices(3) libnutclient_general(3)
64
65
66
67Network UPS Tools 2.7.3.          03/02/2016           LIBNUTCLIENT_VARIABL(3)
Impressum