1NUTSCAN_GET_SERIAL_P(3)           NUT Manual           NUTSCAN_GET_SERIAL_P(3)
2
3
4

NAME

6       nutscan_get_serial_ports_list - Get a port list name from a range of
7       port.
8

SYNOPSIS

10       #include <nut-scan.h>
11
12       char ** nutscan_get_serial_ports_list(const char *ports_range);
13

DESCRIPTION

15       The nutscan_get_serial_ports_list() function returns a null terminated
16       array of strings generated from a port range. ports_range may be one
17       of:
18
19       •   a single character from 0 to 9 or a to z representing a serial
20           communication port depending on the operating system. For instance
21           "0" is converted to /dev/ttyS0 and /dev/ttyUSB0 on Linux; "1" is
22           converted to COM1 on Windows; "c" is converted to /dev/ttyc on
23           Solaris...
24
25       •   a range of character in the form "X-Y". For instance "0-1" will be
26           converted to /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0 and /dev/ttyUSB1
27           on Linux; "1-3" will be converted to COM1, COM2 and COM3 on
28           Windows; "a-c" will be converted to /dev/ttya, /dev/ttyb and
29           /dev/ttyc on Solaris.
30
31       •   a single port name (/dev/ttyS5, COM4...).
32
33       •   a list of port names separated with commas:
34           "/dev/ttyS0,/dev/ttyS2,/dev/ttyS4" or "COM1,COM3"...
35
36       The returned array can be used in a call to nutscan_scan_eaton_serial
37       to get the serial device on a system.
38

RETURN VALUE

40       The nutscan_get_serial_ports_list() function returns NULL if an error
41       occurred (invalid port range) or a pointer to a null terminated array
42       of strings on success.
43

NOTES

45       Technically, the function is currently defined in nutscan-serial.h
46       file.
47

SEE ALSO

49       nutscan_scan_usb(3), nutscan_scan_xml_http_range(3),
50       nutscan_scan_nut(3), nutscan_scan_avahi(3), nutscan_scan_ipmi(3),
51       nutscan_scan_snmp(3), nutscan_scan_eaton_serial(3),
52       nutscan_display_parsable(3), nutscan_display_ups_conf(3)
53
54
55
56Network UPS Tools 2.8.0           04/26/2022           NUTSCAN_GET_SERIAL_P(3)
Impressum