61 lines
2.4 KiB
Groff
61 lines
2.4 KiB
Groff
'\" t
|
|
.\" Title: libnutclient_devices
|
|
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
|
|
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
|
|
.\" Date: 03/02/2016
|
|
.\" Manual: NUT Manual
|
|
.\" Source: Network UPS Tools 2.7.3.1
|
|
.\" Language: English
|
|
.\"
|
|
.TH "LIBNUTCLIENT_DEVICES" "3" "03/02/2016" "Network UPS Tools 2\&.7\&.3\&." "NUT Manual"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "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
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
.nf
|
|
#include <nutclient\&.h>
|
|
.fi
|
|
.sp
|
|
.nf
|
|
typedef void* NUTCLIENT_t;
|
|
.fi
|
|
.sp
|
|
.nf
|
|
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);
|
|
.fi
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
These functions allow to manage devices\&.
|
|
.sp
|
|
The \fBnutclient_get_devices()\fR function retrieve the list of devices monitored by a client\&. The returned strarr must be freed by \fIstrarr_free\fR\&.
|
|
.sp
|
|
The \fBnutclient_has_device()\fR function test if a device is monitored by a client\&.
|
|
.sp
|
|
The \fBnutclient_get_device_description()\fR function retrieve the device description\&. The returned description string must be freed\&.
|
|
.sp
|
|
\fIdev\fR is the device name\&.
|
|
.SH "SEE ALSO"
|
|
.sp
|
|
\fBlibnutclient\fR(3) \fBlibnutclient_commands\fR(3) \fBlibnutclient_devices\fR(3) \fBlibnutclient_general\fR(3) \fBlibnutclient_variables\fR(3)
|