X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Flibmemcached%2Fmemcached_version.rst;h=9c7e840ea10627ad87bb983b2f9e9fa83b068cc3;hb=b7f446e55146456e368c3926347f4c771afcea8c;hp=a5825fab1749e631c988405e36346384889cdd58;hpb=28c4d79e109e11d7d2a9f3189de57da28302ec68;p=awesomized%2Flibmemcached diff --git a/docs/source/libmemcached/memcached_version.rst b/docs/source/libmemcached/memcached_version.rst index a5825fab..9c7e840e 100644 --- a/docs/source/libmemcached/memcached_version.rst +++ b/docs/source/libmemcached/memcached_version.rst @@ -1,53 +1,46 @@ -======================================================= -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) - -.. function:: memcached_return_t memcached_version (memcached_st *ptr) - +.. function:: const char * memcached_lib_version (void) -Compile and link with -lmemcached + :returns: version string of `libmemcached` +.. function:: memcached_return_t memcached_version (memcached_st *ptr) + :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, not server). -:func:`memcached_lib_version` is used to return a simple version string representing the libmemcached version (client library version, not server version) - -: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 ------- +: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 +------------ :func:`memcached_lib_version` returns a string with the version of the libmemcached driver. A value of :type:`memcached_return_t` is returned from :func:'memcached_version' -On success that value will be `MEMCACHED_SUCCESS`. +On success that value will be `MEMCACHED_SUCCESS`. If called with the `MEMCACHED_BEHAVIOR_USE_UDP` behavior set, the value `MEMCACHED_NOT_SUPPORTED` will be returned. -Use :func:`memcached_strerror` to translate this value to +Use :func:`memcached_strerror` to translate this value to a printable string. - - --------- SEE ALSO --------