NAME
nutscan_get_serial_ports_list - Get a port list name from a range of port.
SYNOPSIS
|
Note
|
Two NUT websites
This version of the page reflects NUT release v2.8.1 with codebase commited 4ba352d8f at 2023-10-31T21:46:20+01:00 Options, features and capabilities in current development (and future releases) are detailed on the main site and may differ from ones described here. |
#include <nut-scan.h>char ** nutscan_get_serial_ports_list(const char *ports_range);DESCRIPTION
The nutscan_get_serial_ports_list() function returns a null terminated array of strings generated from a port range. ports_range may be one of:
-
a single character from 0 to 9 or a to z representing a serial communication port depending on the operating system. For instance "0" is converted to /dev/ttyS0 and /dev/ttyUSB0 on Linux; "1" is converted to COM1 on Windows; "c" is converted to /dev/ttyc on Solaris…
-
a range of character in the form "X-Y". For instance "0-1" will be converted to /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0 and /dev/ttyUSB1 on Linux; "1-3" will be converted to COM1, COM2 and COM3 on Windows; "a-c" will be converted to /dev/ttya, /dev/ttyb and /dev/ttyc on Solaris.
-
a single port name (/dev/ttyS5, COM4…).
-
a list of port names separated with commas: "/dev/ttyS0,/dev/ttyS2,/dev/ttyS4" or "COM1,COM3"…
The returned array can be used in a call to nutscan_scan_eaton_serial to get the serial device on a system.
RETURN VALUE
The nutscan_get_serial_ports_list() function returns NULL if an error occurred (invalid port range) or a pointer to a null terminated array of strings on success.
NOTES
Technically, the function is currently defined in nutscan-serial.h file.