Updated client library with version 0.1.5 (rev. 1665), for changes see change log

1 files changed, 16 insertions, 11 deletions

diff --git a/include/persistence_client_library_key.h b/include/persistence_client_library_key.h
index 7818916..23cc01e 100644
--- a/include/persistence_client_library_key.h
+++ b/include/persistence_client_library_key.h
@@ -58,7 +58,8 @@ extern "C" {
  * @param user_no  the user ID
  * @param seat_no  the seat number (seat 0 to 3)
  *
- * @return positive value: success; negative value: error code
+ * @return positive value: success; On error a negative value will be returned with th follwoing error codes:
+ * EPERS_LOCKFS
  */
 int key_delete(unsigned char ldbid, char* resource_id, unsigned char user_no, unsigned char seat_no);
 
@@ -72,7 +73,8 @@ int key_delete(unsigned char ldbid, char* resource_id, unsigned char user_no, un
  * @param user_no  the user ID
  * @param seat_no  the seat number (seat 0 to 3)
  *
- * @return positive value: the size; negative value: error code
+ * @return positive value: the size; On error a negative value will be returned with th follwoing error codes:
+ * EPERS_LOCKFS, EPERS_BADPOL, EPERS_NOKEY, EPERS_NOKEYDATA or EPERS_NOPRCTABLE
  */
 int key_get_size(unsigned char ldbid, char* resource_id, unsigned char user_no, unsigned char seat_no);
 
@@ -81,7 +83,8 @@ int key_get_size(unsigned char ldbid, char* resource_id, unsigned char user_no,
  *
  * @param key_handle key value handle return by key_handle_open()
  *
- * @return positive value: success; negative value: error code
+ * @return positive value: success; On error a negative value will be returned with th follwoing error codes:
+ * EPERS_LOCKFS
  */
 int key_handle_close(int key_handle);
 
@@ -92,7 +95,7 @@ int key_handle_close(int key_handle);
  *
  * @param key_handle key value handle return by key_handle_open()
  *
- * @return positive value: the size; negative value: error code
+ * @return positive value: the size; On error a negative value will be returned with th follwoing error codes:
  */
 int key_handle_get_size(int key_handle);
 
@@ -106,7 +109,8 @@ int key_handle_get_size(int key_handle);
  * @param user_no  the user ID
  * @param seat_no  the seat number (seat 0 to 3)
  *
- * @return positive value: the key handle to access the value; negative value: Error code
+ * @return positive value: the key handle to access the value;
+ * On error a negative value will be returned with th follwoing error codes:
  */
 int key_handle_open(unsigned char ldbid, char* resource_id, unsigned char user_no, unsigned char seat_no);
 
@@ -119,7 +123,8 @@ int key_handle_open(unsigned char ldbid, char* resource_id, unsigned char user_n
  * @param buffer the buffer for persistent data
  * @param buffer_size size of buffer for reading
  *
- * @return positive value: the bytes read; negative value: error code
+ * @return positive value: the bytes read; On error a negative value will be returned with th follwoing error codes:
+ *
  */
 int key_handle_read_data(int key_handle, unsigned char* buffer, unsigned long buffer_size);
 
@@ -130,7 +135,7 @@ int key_handle_read_data(int key_handle, unsigned char* buffer, unsigned long bu
  *
  * @param key_handle key value handle return by key_handle_open()
  *
- * @return positive value: registration OK; negative value: error code
+ * @return positive value: registration OK; On error a negative value will be returned with th follwoing error codes:
  */
 int key_handle_register_notify_on_change(int key_handle);
 
@@ -144,7 +149,7 @@ int key_handle_register_notify_on_change(int key_handle);
  * @param buffer_size the number of bytes to write (default max size is set to 16kB)
  *                    use environment variable PERS_MAX_KEY_VAL_DATA_SIZE to modify default size in bytes
  *
- * @return positive value: the bytes written; negative value: error code
+ * @return positive value: the bytes written; On error a negative value will be returned with th follwoing error codes:
  */
 int key_handle_write_data(int key_handle, unsigned char* buffer, unsigned long buffer_size);
 
@@ -160,7 +165,7 @@ int key_handle_write_data(int key_handle, unsigned char* buffer, unsigned long b
  * @param buffer the buffer to read the persistent data
  * @param buffer_size size of buffer for reading
  *
- * @return positive value: the bytes read; negative value: error code
+ * @return positive value: the bytes read; On error a negative value will be returned with th follwoing error codes:
  */
 int key_read_data(unsigned char ldbid, char* resource_id, unsigned char user_no, unsigned char seat_no, unsigned char* buffer, unsigned long buffer_size);
 
@@ -174,7 +179,7 @@ int key_read_data(unsigned char ldbid, char* resource_id, unsigned char user_no,
  * @param user_no  the user ID
  * @param seat_no  the seat number (seat 0 to 3)
  *
- * @return positive value: registration OK; negative value: error code
+ * @return positive value: registration OK; On error a negative value will be returned with th follwoing error codes:
  */
 int key_register_notify_on_change(unsigned char ldbid, char* resource_id, unsigned char user_no, unsigned char seat_no);
 
@@ -191,7 +196,7 @@ int key_register_notify_on_change(unsigned char ldbid, char* resource_id, unsign
  * @param buffer_size the number of bytes to write (default max size is set to 16kB)
  *                    use environment variable PERS_MAX_KEY_VAL_DATA_SIZE to modify default size in bytes
  *
- * @return positive value: the bytes written; negative value: error code
+ * @return positive value: the bytes written; On error a negative value will be returned with th follwoing error codes:
  */
 int key_write_data(unsigned char ldbid, char* resource_id, unsigned char user_no, unsigned char seat_no, unsigned char* buffer, unsigned long buffer_size);