diff options
author | Brian Aker <brian@tangent.org> | 2014-02-16 01:06:40 -0800 |
---|---|---|
committer | Brian Aker <brian@tangent.org> | 2014-02-16 01:06:40 -0800 |
commit | f2a59b728c20f7fe78874dd41187ab3fb2db6c7e (patch) | |
tree | 0eb8f025a8916f509ede181662ae66a544ae49cd /docs/source/libmemcached-1.0/memcached_set_encoding_key.rst | |
parent | dbc62573e1a6dc8cbcc97d0898e8615b0916d6ab (diff) | |
download | libmemcached-f2a59b728c20f7fe78874dd41187ab3fb2db6c7e.tar.gz |
Fix for building docs.
Diffstat (limited to 'docs/source/libmemcached-1.0/memcached_set_encoding_key.rst')
-rw-r--r-- | docs/source/libmemcached-1.0/memcached_set_encoding_key.rst | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/docs/source/libmemcached-1.0/memcached_set_encoding_key.rst b/docs/source/libmemcached-1.0/memcached_set_encoding_key.rst new file mode 100644 index 00000000..be38b03f --- /dev/null +++ b/docs/source/libmemcached-1.0/memcached_set_encoding_key.rst @@ -0,0 +1,58 @@ +================== +Set encryption key +================== + +.. index:: object: memcached_st + +-------- +SYNOPSIS +-------- + +#include <libmemcached/memcached.h> + +.. c:function:: void memcached_set_encoding_key (memcached_st *ptr, const char *string, const size_t string_length) + +Compile and link with -lmemcached + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_set_encoding_key` sets the key that will be used to encrypt and decrypt data as it is sent and recieved from the server. + +Currently only AES is is supported. + + +------ +RETURN +------ + + +A value of type :c:type:`memcached_return_t` is returned On success that value +will be :c:type:`MEMCACHED_SUCCESS`. Use :c:func:`memcached_strerror` to +translate this value to a printable string. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ <http://libmemcached.org/>`_ + + +------ +AUTHOR +------ + + +Brian Aker, <brian@tangent.org> + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` |