fetch_result() implemented for memcached_result_st.

[awesomized/libmemcached] / docs / memcached_get.pod

diff --git a/docs/memcached_get.pod b/docs/memcached_get.pod
index 1c95ec38ca22d3ce32234d52199fb09797987033..458a55a9571479a6ea58bfe382ad9d27e4bd011e 100755 (executable)
--- a/docs/memcached_get.pod
+++ b/docs/memcached_get.pod
@@ -10,6 +10,11 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
   #include <memcached.h>
 
+  memcached_result_st *
+  memcached_fetch_result(memcached_st *ptr, 
+                      memcached_result_st *result,
+                      memcached_return *error);
+
   char *memcached_get (memcached_st *ptr,
                        char *key, size_t key_length,
                        size_t *value_length, 
@@ -51,6 +56,12 @@ 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. 
 
+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
+to the server. For more information please refer to the memcached_result_st(3) 
+help. This function will dynamically allocate a result structure for you
+if you do not pass one to the function.
+
 =head1 RETURN
 
 All objects returned must be freed by the calling application.