Merge pull request #140 from hussainnaqvee/patch-1
[awesomized/libmemcached] / libmemcached / memcached_verbosity.rst
1 Setting the verbosity of a server
2 =================================
3
4 SYNOPSIS
5 --------
6
7 #include <libmemcached/memcached.h>
8 Compile and link with -lmemcached
9
10 .. function:: memcached_return_t memcached_verbosity (memcached_st *ptr, uint32_t verbosity)
11
12 :param ptr: pointer to initialized `memcached_st` struct
13 :param verbosity: level of verbosity
14 :returns: `memcached_return_t` indicating success
15
16 DESCRIPTION
17 -----------
18
19 :func:`memcached_verbosity` modifies the "verbosity" of the
20 :manpage:`memcached(1)` servers referenced in the :type:`memcached_st` parameter.
21
22 RETURN VALUE
23 ------------
24
25 A value of type :type:`memcached_return_t` is returned.
26
27 On success that value will be `MEMCACHED_SUCCESS`.
28
29 Use :func:`memcached_strerror` to translate this value to a printable string.
30
31 SEE ALSO
32 --------
33
34 .. only:: man
35
36 :manpage:`memcached(1)`
37 :manpage:`libmemcached(3)`
38 :manpage:`memcached_strerror(3)`
39
40 .. only:: html
41
42 * :manpage:`memcached(1)`
43 * :doc:`../libmemcached`
44 * :doc:`memcached_strerror`