File: libnutclient_commands.txt

package info (click to toggle)
nut 2.7.4-8
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 10,964 kB
  • sloc: ansic: 70,278; sh: 12,814; python: 2,202; cpp: 1,715; makefile: 1,406; perl: 705; xml: 40
file content (47 lines) | stat: -rw-r--r-- 1,506 bytes parent folder | download | duplicates (4)
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
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;

	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);

DESCRIPTION
-----------

These functions allow to manage instant commands of devices.

The *nutclient_get_device_commands()* function retrieve the list of command names for a device.
The returned strarr must be freed by 'strarr_free'.

The *nutclient_has_device_command* function test if the specified command is supported by the device.
Return 1 is supported and 0 if not.

The *nutclient_get_device_command_description* function retrieve the command description, if any.
The resturned string must be freed.

The *nutclient_execute_device_command* intend to execute the instant command.

'dev' is the device name.

'cmd' is the instant command name.

SEE ALSO
--------
linkman:libnutclient[3]
linkman:libnutclient_devices[3]
linkman:libnutclient_general[3]