]> sigrok.org Git - libserialport.git/commitdiff
doc: Additional notes on sp_last_error_{code,message}.
authorMartin Ling <redacted>
Sun, 24 May 2015 12:47:09 +0000 (13:47 +0100)
committerUwe Hermann <redacted>
Wed, 27 May 2015 09:09:26 +0000 (11:09 +0200)
libserialport.h.in

index a4bd00e5b2f634bdfec71eb7f0267ce15e3ae31a..c8defbed5c363bcf9c7e0245e475e9aeaa58906c 100644 (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
  * 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
  *         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
  * 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
  *         operation to fail. This string may be allocated by the function,