Imported Upstream version 2.7.1
This commit is contained in:
parent
a1fa151fc7
commit
0121794af9
451 changed files with 41339 additions and 10887 deletions
45
docs/man/libnutclient_general.txt
Normal file
45
docs/man/libnutclient_general.txt
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
LIBNUTCLIENT_GENERAL(3)
|
||||
=======================
|
||||
|
||||
NAME
|
||||
----
|
||||
|
||||
libnutclient_general, nutclient_destroy, strarr_alloc, strarr_free -
|
||||
General and utility functions in Network UPS Tools high-level client access library
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
|
||||
#include <nutclient.h>
|
||||
|
||||
typedef void* NUTCLIENT_t;
|
||||
|
||||
void nutclient_destroy(NUTCLIENT_t client);
|
||||
|
||||
typedef char** strarr;
|
||||
|
||||
strarr strarr_alloc(unsigned short count);
|
||||
void strarr_free(strarr arr);
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
The *nutclient_destroy()* function destroys a 'NUTCLIENT_t' or derived
|
||||
(like 'NUTCLIENT_TCP_t') connection object, and frees allocated memory.
|
||||
|
||||
The *strarr* type represents an array of C strings (array of char pointer).
|
||||
The array must always be terminated by a NULL pointer.
|
||||
Pointed strings must be allocated by (x)calloc or (x)strdup.
|
||||
|
||||
The *strarr_alloc()* function allocates a 'strarr' array with the specified
|
||||
number of (non-initialized) string pointers.
|
||||
Another additional pointer set to 0 is added at the end of the array.
|
||||
|
||||
The *strarr_free* function frees a 'strarr' array.
|
||||
It also frees all pointed strings.
|
||||
|
||||
'dev' is the device name.
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
linkman:libnutclient[3]
|
||||
Loading…
Add table
Add a link
Reference in a new issue