1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
LIBNUTCLIENT_COMMANDS(3)
========================
NAME
----
libnutclient_commands, nutclient_get_device_commands,
nutclient_has_device_command, nutclient_get_device_command_description,
nutclient_execute_device_command -
Instant command 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_commands(
NUTCLIENT_t client,
const char* dev);
int nutclient_has_device_command(
NUTCLIENT_t client,
const char* dev, const char* cmd);
char* nutclient_get_device_command_description(
NUTCLIENT_t client,
const char* dev, const char* cmd);
void nutclient_execute_device_command(
NUTCLIENT_t client,
const char* dev, const char* cmd,
const char* param="");
------
DESCRIPTION
-----------
These functions allow to manage instant commands of devices.
* The *nutclient_get_device_commands()* function retrieves
the list of command names for a device.
+
The returned strarr must be freed by 'strarr_free'.
* The *nutclient_has_device_command* function tests if the
specified command is supported by the device.
+
Return '1' if supported and '0' if not.
* The *nutclient_get_device_command_description* function
retrieves the command description, if any.
+
The returned string must be freed by linkmanext:free[3]
(see linkman:libnutclient_general[3]).
* The *nutclient_execute_device_command* intends to execute
the instant command, with an optional parameter.
Common arguments:
* 'dev' is the device name.
* 'cmd' is the instant command name.
SEE ALSO
--------
linkman:libnutclient[3]
linkman:libnutclient_devices[3]
linkman:libnutclient_general[3]
|
