diff options
author | Ingo Huerner <ingo.huerner@xse.de> | 2014-05-09 05:19:48 +0200 |
---|---|---|
committer | Ingo Huerner <ingo.huerner@xse.de> | 2014-05-09 05:19:48 +0200 |
commit | b5c52f74865d8e95db66a36fae4acb23ed22f16f (patch) | |
tree | 762f0ab543e280f68c982c7791db2029cabaff29 /include | |
parent | 5d04ae9d019b1072612e935eb13e198834a23b0f (diff) | |
download | persistence-client-library-b5c52f74865d8e95db66a36fae4acb23ed22f16f.tar.gz |
Code cleanup and optimisation
Diffstat (limited to 'include')
-rw-r--r-- | include/persistence_client_library.h | 2 | ||||
-rw-r--r-- | include/persistence_client_library_error_def.h | 2 | ||||
-rw-r--r-- | include/persistence_client_library_key.h | 16 |
3 files changed, 11 insertions, 9 deletions
diff --git a/include/persistence_client_library.h b/include/persistence_client_library.h index 1e6b085..9328712 100644 --- a/include/persistence_client_library.h +++ b/include/persistence_client_library.h @@ -24,7 +24,7 @@ * */ /** \ingroup GEN_PERS */ -/** \defgroup PERS_CLIENT Client: initialization access +/** \defgroup PERS_CLIENT Client: initialisation access * \{ */ /** \defgroup PERS_CLIENT_INTERFACE API document diff --git a/include/persistence_client_library_error_def.h b/include/persistence_client_library_error_def.h index e88efa5..f8e184b 100644 --- a/include/persistence_client_library_error_def.h +++ b/include/persistence_client_library_error_def.h @@ -116,6 +116,8 @@ extern "C" { #define EPERS_SHUTDOWN_MAX_CANCEL (-40) /// not permitted to use this function #define EPERS_SHUTDOWN_NO_PERMIT (-42) +/// requested handle is not valid. \since PCL v7.0.3 +#define EPERS_INVALID_HANDLE (-1000) #ifdef __cplusplus } diff --git a/include/persistence_client_library_key.h b/include/persistence_client_library_key.h index 46d0e8c..4111fe3 100644 --- a/include/persistence_client_library_key.h +++ b/include/persistence_client_library_key.h @@ -78,7 +78,7 @@ typedef struct _pclNotification_s /** definition of the change callback * - * @param notifyStruct structure for notifcation + * @param notifyStruct structure for notification * * @return positive value (0 or greater): success; * On error a negative value will be returned with the following error codes: ::EPERS_LOCKFS @@ -95,7 +95,7 @@ typedef int(* pclChangeNotifyCallback_t)(pclNotification_s * notifyStruct); * * @param ldbid logical database ID * @param resource_id the resource ID - * @param user_no the user ID; user_no=0 can not be used as user-ID beacause ‘0’ is defined as System/node + * @param user_no the user ID; user_no=0 can not be used as user-ID because ‘0’ is defined as System/node * @param seat_no the seat number * * @return positive value (0 or greater) : success; @@ -111,7 +111,7 @@ int pclKeyDelete(unsigned int ldbid, const char* resource_id, unsigned int user_ * * @param ldbid logical database ID * @param resource_id the resource ID - * @param user_no the user ID; user_no=0 can not be used as user-ID beacause ‘0’ is defined as System/node + * @param user_no the user ID; user_no=0 can not be used as user-ID because ‘0’ is defined as System/node * @param seat_no the seat number * * @return positive value (0 or greater): the size; @@ -153,7 +153,7 @@ int pclKeyHandleGetSize(int key_handle); * * @param ldbid logical database ID * @param resource_id the resource ID - * @param user_no the user ID; user_no=0 can not be used as user-ID beacause ‘0’ is defined as System/node + * @param user_no the user ID; user_no=0 can not be used as user-ID because ‘0’ is defined as System/node * @param seat_no the seat number * * @return positive value (0 or greater): the key handle to access the value; @@ -229,7 +229,7 @@ int pclKeyHandleWriteData(int key_handle, unsigned char* buffer, int buffer_size * * @param ldbid logical database ID * @param resource_id the resource ID - * @param user_no the user ID; user_no=0 can not be used as user-ID beacause ‘0’ is defined as System/node + * @param user_no the user ID; user_no=0 can not be used as user-ID because ‘0’ is defined as System/node * @param seat_no the seat number * @param buffer the buffer to read the persistent data * @param buffer_size size of buffer for reading @@ -247,7 +247,7 @@ int pclKeyReadData(unsigned int ldbid, const char* resource_id, unsigned int use * * @param ldbid logical database ID of the resource to monitor * @param resource_id the resource ID - * @param user_no the user ID; user_no=0 can not be used as user-ID beacause ‘0’ is defined as System/node + * @param user_no the user ID; user_no=0 can not be used as user-ID because ‘0’ is defined as System/node * @param seat_no the seat number * @param callback notification callback * @@ -264,7 +264,7 @@ int pclKeyRegisterNotifyOnChange(unsigned int ldbid, const char* resource_id, un * * @param ldbid logical database ID of the resource to monitor * @param resource_id the resource ID - * @param user_no the user ID; user_no=0 can not be used as user-ID beacause ‘0’ is defined as System/node + * @param user_no the user ID; user_no=0 can not be used as user-ID because ‘0’ is defined as System/node * @param seat_no the seat number * @param callback notification callback * @@ -281,7 +281,7 @@ int pclKeyUnRegisterNotifyOnChange( unsigned int ldbid, const char * resource_ * * @param ldbid logical database ID * @param resource_id the resource ID - * @param user_no the user ID; user_no=0 can not be used as user-ID beacause ‘0’ is defined as System/node + * @param user_no the user ID; user_no=0 can not be used as user-ID because ‘0’ is defined as System/node * @param seat_no the seat number * @param buffer the buffer containing the persistent data to write * @param buffer_size the number of bytes to write (default max size is set to 16kB) |