summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorIngo Huerner <ingo.huerner@xse.de>2013-02-27 09:35:28 +0100
committerIngo Huerner <ingo.huerner@xse.de>2013-02-27 09:35:28 +0100
commitf89f21a4789c39a88b46ee32b2a2eed46367f98b (patch)
tree15651d6a9fb246b29d8ffb8d9e3480b6128614fa /include
parent3964e0965ce0b474bcf18350869d8c4ab8d1c69e (diff)
downloadpersistence-client-library-f89f21a4789c39a88b46ee32b2a2eed46367f98b.tar.gz
Updated Lifecycle interface names; added information about user_no=0 in header filesv0.5.0
Diffstat (limited to 'include')
-rw-r--r--include/persistence_client_library_file.h4
-rw-r--r--include/persistence_client_library_key.h12
2 files changed, 8 insertions, 8 deletions
diff --git a/include/persistence_client_library_file.h b/include/persistence_client_library_file.h
index 25690d0..f56ccd2 100644
--- a/include/persistence_client_library_file.h
+++ b/include/persistence_client_library_file.h
@@ -78,7 +78,7 @@ void* pclFileMapData(void* addr, long size, long offset, int fd);
*
* @param ldbid logical database ID
* @param resource_id the resource ID
- * @param user_no the user 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 seat_no the seat number
*
* @return positive value: the POSIX file descriptor;
@@ -109,7 +109,7 @@ int pclFileReadData(int fd, void * buffer, int buffer_size);
*
* @param ldbid logical database ID
* @param resource_id the resource ID
- * @param user_no the user 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 seat_no the seat number
*
* @return positive value: success;
diff --git a/include/persistence_client_library_key.h b/include/persistence_client_library_key.h
index 7f6b850..72acf65 100644
--- a/include/persistence_client_library_key.h
+++ b/include/persistence_client_library_key.h
@@ -41,7 +41,7 @@ extern "C" {
*
* @param ldbid logical database ID
* @param resource_id the resource ID
- * @param user_no the user 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 seat_no the seat number
*
* @return positive value: success; On error a negative value will be returned with th follwoing error codes:
@@ -56,7 +56,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
+ * @param user_no the user ID; user_no=0 can not be used as user-ID beacause ‘0’ is defined as System/node
* @param seat_no the seat number
*
* @return positive value: the size; On error a negative value will be returned with th follwoing error codes:
@@ -92,7 +92,7 @@ int pclKeyHandleGetSize(int key_handle);
*
* @param ldbid logical database ID
* @param resource_id the resource ID
- * @param user_no the user 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 seat_no the seat number
*
* @return positive value: the key handle to access the value;
@@ -146,7 +146,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
+ * @param user_no the user ID; user_no=0 can not be used as user-ID beacause ‘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
@@ -162,7 +162,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
+ * @param user_no the user ID; user_no=0 can not be used as user-ID beacause ‘0’ is defined as System/node
* @param seat_no the seat number
*
* @return positive value: registration OK; On error a negative value will be returned with th follwoing error codes:
@@ -176,7 +176,7 @@ int pclKeyRegisterNotifyOnChange(unsigned int ldbid, const char* resource_id, un
*
* @param ldbid logical database ID
* @param resource_id the resource ID
- * @param user_no the user 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 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)