X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Flibmemcached%2Fmemcached_version.rst;h=6acb6c590ddf6103146aa1ff4cdac4b0bd188b94;hb=43032f572a83233b5183ed6989921efe930aa719;hp=a5825fab1749e631c988405e36346384889cdd58;hpb=28c4d79e109e11d7d2a9f3189de57da28302ec68;p=m6w6%2Flibmemcached diff --git a/docs/source/libmemcached/memcached_version.rst b/docs/source/libmemcached/memcached_version.rst index a5825fab..6acb6c59 100644 --- a/docs/source/libmemcached/memcached_version.rst +++ b/docs/source/libmemcached/memcached_version.rst @@ -1,53 +1,39 @@ -======================================================= Getting version information about the client and server ======================================================= - --------- SYNOPSIS -------- #include -.. function:: const char * memcached_lib_version (void) +.. function:: const char * memcached_lib_version (void) .. function:: memcached_return_t memcached_version (memcached_st *ptr) - Compile and link with -lmemcached - - ------------ 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_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_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 --------