File: libnutclient_devices.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 (43 lines) | stat: -rw-r--r-- 1,134 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
LIBNUTCLIENT_DEVICES(3)
=======================

NAME
----

libnutclient_devices, nutclient_get_devices, nutclient_has_device, nutclient_get_device_description -
Device related functions in Network UPS Tools high-level client access library

SYNOPSIS
--------

	#include <nutclient.h>

	typedef void* NUTCLIENT_t;

	strarr nutclient_get_devices(NUTCLIENT_t client);
	int nutclient_has_device(NUTCLIENT_t client, const char* dev);
	char* nutclient_get_device_description(NUTCLIENT_t client, const char* dev);

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

These functions allow to manage devices.

The *nutclient_get_devices()* function retrieve the list of devices monitored by a client.
The returned strarr must be freed by 'strarr_free'.

The *nutclient_has_device()* function test if a device is monitored by a client.

The *nutclient_get_device_description()* function retrieve the device description.
The returned description string must be freed.

'dev' is the device name.

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