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

NAME

6       libnutclient_commands, nutclient_get_device_commands,
7       nutclient_has_device_command, nutclient_get_device_command_description,
8       nutclient_execute_device_command - Instant command related functions in
9       Network UPS Tools high-level client access library
10

SYNOPSIS

12       #include <nutclient.h>
13
14       typedef void* NUTCLIENT_t;
15
16       strarr nutclient_get_device_commands(NUTCLIENT_t client, const char* dev);
17       int nutclient_has_device_command(NUTCLIENT_t client, const char* dev, const char* cmd);
18       char* nutclient_get_device_command_description(NUTCLIENT_t client, const char* dev, const char* cmd);
19       void nutclient_execute_device_command(NUTCLIENT_t client, const char* dev, const char* cmd);
20

DESCRIPTION

22       These functions allow to manage instant commands of devices.
23
24       The nutclient_get_device_commands() function retrieve the list of
25       command names for a device. The returned strarr must be freed by
26       strarr_free.
27
28       The nutclient_has_device_command function test if the specified command
29       is supported by the device. Return 1 is supported and 0 if not.
30
31       The nutclient_get_device_command_description function retrieve the
32       command description, if any. The resturned string must be freed.
33
34       The nutclient_execute_device_command intend to execute the instant
35       command.
36
37       dev is the device name.
38
39       cmd is the instant command name.
40

SEE ALSO

42       libnutclient(3) libnutclient_devices(3) libnutclient_general(3)
43
44
45
46Network UPS Tools 2.7.3.          03/02/2016           LIBNUTCLIENT_COMMAND(3)
Impressum