Clarify caller return behavior
authorBrian Aker <brian@tangent.org>
Tue, 22 Jan 2008 18:17:42 +0000 (10:17 -0800)
committerBrian Aker <brian@tangent.org>
Tue, 22 Jan 2008 18:17:42 +0000 (10:17 -0800)
docs/memcached_get.pod

index 1cf0a60ca053443c9e6d41f627e25883ce17069d..bd8623bbd42ea3cf712fcc85f8e65de011bf0b3a 100755 (executable)
@@ -58,7 +58,8 @@ three pointer variables which will give you the state of the returned
 object.  A uint32_t pointer to contain whatever flags you stored with the value,
 a size_t pointer which will be filled with size of of the object, and a
 memcached_return pointer to hold any error. The object will be returned
-upon success and NULL will be returned on failure. 
+upon success and NULL will be returned on failure. Any object returned by
+memcached_get() must be released by the caller application. 
 
 memcached_mget() is used to select multiple keys at once. For multiple key
 operations it is always faster to use this function. This function always
@@ -77,7 +78,10 @@ three pointer variables which will give you the state of the returned
 object.  A uint32_t pointer to contain whatever flags you stored with the value,
 a size_t pointer which will be filled with size of of the object, and a
 memcached_return pointer to hold any error. The object will be returned
-upon success and NULL will be returned on failure. 
+upon success and NULL will be returned on failure. MEMCACHD_END is returned
+by the *error value when all objects that have been found are returned. 
+The final value upon MEMCACHED_END is null. Values returned by
+memcached_fetch() musted be free'ed by the caller.
 
 memcached_fetch_result() is used to return a memcached_result_st(3) structure 
 from a memcached server. The result object is forward compatible with changes