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

doc: Additional notes on sp_last_error_{code,message}.

Browse Source
This commit is contained in:
Martin Ling 2015-05-24 13:47:09 +01:00 committed by Uwe Hermann
parent 46d8b0a039
commit ec4b55ae25
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
libserialport.h.in
View File

@ -1335,6 +1335,8 @@ enum sp_return sp_end_break(struct sp_port *port);
* *
* In order to obtain the correct result, this function should be called * In order to obtain the correct result, this function should be called
* straight after the failure, before executing any other system operations. * straight after the failure, before executing any other system operations.
* The result is thread-specific, and only valid when called immediately
* after a previous call returning SP_ERR_FAIL.
* *
* @return The system's numeric code for the error that caused the last * @return The system's numeric code for the error that caused the last
* operation to fail. * operation to fail.
@ -1348,6 +1350,8 @@ int sp_last_error_code(void);
* *
* In order to obtain the correct result, this function should be called * In order to obtain the correct result, this function should be called
* straight after the failure, before executing other system operations. * straight after the failure, before executing other system operations.
* The result is thread-specific, and only valid when called immediately
* after a previous call returning SP_ERR_FAIL.
* *
* @return The system's message for the error that caused the last * @return The system's message for the error that caused the last
* operation to fail. This string may be allocated by the function, * operation to fail. This string may be allocated by the function,