X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Flibmemcached%2Fmemcached_version.rst;h=9c7e840ea10627ad87bb983b2f9e9fa83b068cc3;hb=b7f446e55146456e368c3926347f4c771afcea8c;hp=e11c83344638753be893fc6a2faf668a4590fded;hpb=0a654f848e13d470fb07b044347f2e91d6941807;p=awesomized%2Flibmemcached diff --git a/docs/source/libmemcached/memcached_version.rst b/docs/source/libmemcached/memcached_version.rst index e11c8334..9c7e840e 100644 --- a/docs/source/libmemcached/memcached_version.rst +++ b/docs/source/libmemcached/memcached_version.rst @@ -1,23 +1,30 @@ -Getting version information about the client and server -======================================================= +Getting version information +=========================== SYNOPSIS -------- #include + Compile and link with -lmemcached .. function:: const char * memcached_lib_version (void) + :returns: version string of `libmemcached` + .. function:: memcached_return_t memcached_version (memcached_st *ptr) -Compile and link with -lmemcached + :param ptr: pointer to initialized `memcached_st` struct + :returns: `memcached_return_t` indicating success DESCRIPTION ----------- -:func:`memcached_lib_version` is used to return a simple version string representing the libmemcached version (client library version, not server version) +:func:`memcached_lib_version` is used to return a simple version string +representing the `libmemcached` version (client library, not server). -:func:`memcached_version` is used to set the major, minor, and micro versions of each memcached server being used by the memcached_st connection structure. It returns the memcached server return code. +:func:`memcached_version` is used to set the major, minor, and micro versions of +each memcached server being used by the `memcached_st` connection structure. +It returns the memcached server return code. RETURN VALUE ------------