mirror/libserialport
mirror/libserialport
1
0
Fork 0
mirror of git://sigrok.org/libserialport synced 2023-08-10 21:13:24 +03:00
Code Issues Projects Releases Wiki Activity

Update documentation.

Browse Source
This commit is contained in:
Martin Ling 2013-11-03 23:12:03 +00:00 committed by Uwe Hermann
parent f9796bcb86
commit c45eb4bee2
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README
View File

@ -61,8 +61,9 @@ API
The API is simple, and designed to be a minimal wrapper around the serial port The API is simple, and designed to be a minimal wrapper around the serial port
support in each OS. support in each OS.
Most functions take a pointer to a struct sp_port, which represents an serial Most functions take a pointer to a struct sp_port, which represents a serial
port. This structure is obtained from the array returned by sp_list_ports(). port. These structures are always allocated and freed by the library, using the
functions in the 'Enumeration' section below.
All functions can return only three possible error values. SP_ERR_ARG indicates All functions can return only three possible error values. SP_ERR_ARG indicates
the function was called with invalid arguments. SP_ERR_FAIL indicates that the the function was called with invalid arguments. SP_ERR_FAIL indicates that the