]> sigrok.org Git - libserialport.git/commitdiff
Add SP_ERR_MEM failure code.
authorMartin Ling <redacted>
Sun, 3 Nov 2013 20:21:36 +0000 (20:21 +0000)
committerUwe Hermann <redacted>
Thu, 14 Nov 2013 23:42:38 +0000 (00:42 +0100)
README
serialport.h

diff --git a/README b/README
index 5958d8925d32e7f56868d1c46df1a1def9690684..e0ace9787d3077d168d0ccd12fbe698b1f355e45 100644 (file)
--- a/README
+++ b/README
@@ -65,9 +65,10 @@ Most functions take a pointer to a struct sp_port, which represents an open
 port. This structure should be allocated by the user and is populated by
 sp_open(). It can be freed safely after sp_close().
 
-All functions can return only two 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
-OS reported a failure. Both these error values are negative.
+OS reported a failure. SP_ERR_MEM indicates that a memory allocation failed.
+Aoth these error values are negative.
 
 When SP_ERR_FAIL is returned, an error code or string description of the error
 can be obtained by calling sp_last_error_code() or sp_last_error_message(). The
index dafe99bfbcf4eb447f9a3bb8c9851a929d15e43d..3d6410e071308e0816457ebfa28a95cfe3fa0b15 100644 (file)
@@ -41,10 +41,12 @@ struct sp_port {
 enum {
        /* Operation completed successfully. */
        SP_OK = 0,
-       /* A system error occured while executing the operation. */
-       SP_ERR_FAIL = -1,
        /* Invalid arguments were passed to the function. */
-       SP_ERR_ARG = -2
+       SP_ERR_ARG = -1,
+       /* A system error occured while executing the operation. */
+       SP_ERR_FAIL = -2,
+       /* A memory allocation failed while executing the operation. */
+       SP_ERR_MEM = -3
 };
 
 /* Port access modes. */