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

Clarify return values of sp_get_port_by_name() and sp_list_ports().

Browse Source
This commit is contained in:
Martin Ling 2013-11-03 22:38:50 +00:00 committed by Uwe Hermann
parent 25ab82f6c0
commit b9a462bb47
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README
View File

@ -87,10 +87,13 @@ int sp_get_port_by_name(const char *portname, struct sp_port **port_ptr);
Obtains a pointer to a new sp_port structure representing the named port. The Obtains a pointer to a new sp_port structure representing the named port. The
user should allocate a variable of type "struct sp_port *" and pass a pointer user should allocate a variable of type "struct sp_port *" and pass a pointer
to this to receive the result. to this to receive the result.
The result should be freed after use by calling sp_free_port().
Returns: SP_OK on success, SP_ERR_FAIL on failure, SP_ERR_MEM on allocation failure, Returns: SP_OK on success, SP_ERR_FAIL on failure, SP_ERR_MEM on allocation
or SP_ERR_ARG if an invalid pointer is passed. If any error is returned, failure, or SP_ERR_ARG if an invalid pointer is passed. If any error
the value pointed to by port_ptr will be set to NULL. is returned, the variable pointed to by port_ptr will be set to NULL.
Otherwise, it will be set to point to the newly allocated port.
void sp_free_port(struct sp_port *port); void sp_free_port(struct sp_port *port);
@ -105,9 +108,10 @@ int sp_list_ports(struct sp_port ***list_ptr);
The result should be freed after use by calling sp_free_port_list(). The result should be freed after use by calling sp_free_port_list().
Returns: SP_OK on success, SP_ERR_FAIL on failure, SP_ERR_MEM on allocation failure, Returns: SP_OK on success, SP_ERR_FAIL on failure, SP_ERR_MEM on allocation
or SP_ERR_ARG if an invalid pointer is passed. If any error is returned, failure, or SP_ERR_ARG if an invalid pointer is passed. If any error
the value pointed to by list_ptr will be set to NULL. is returned, the variable pointed to by list_ptr will be set to NULL.
Otherwise, it will be set to point to the newly allocated array.
void sp_free_port_list(struct sp_port **list); void sp_free_port_list(struct sp_port **list);