X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fsource%2Flibmemcached%2Fmemcached_set_encoding_key.rst;h=38ddba092ad11896eb94d8f15d8b6c0512c02a81;hb=d55b8d845388672d97fdeab8bf91066ba79b3103;hp=d8b15a877b2567df35a0fed1ad31a1adc15e827a;hpb=28c4d79e109e11d7d2a9f3189de57da28302ec68;p=m6w6%2Flibmemcached diff --git a/docs/source/libmemcached/memcached_set_encoding_key.rst b/docs/source/libmemcached/memcached_set_encoding_key.rst index d8b15a87..38ddba09 100644 --- a/docs/source/libmemcached/memcached_set_encoding_key.rst +++ b/docs/source/libmemcached/memcached_set_encoding_key.rst @@ -1,41 +1,31 @@ -================== Set encryption key ================== .. index:: object: memcached_st --------- SYNOPSIS -------- #include - + .. function:: void memcached_set_encoding_key (memcached_st *ptr, const char *string, const size_t string_length) Compile and link with -lmemcached ------------ DESCRIPTION ----------- - :func:`memcached_set_encoding_key` sets the key that will be used to encrypt and decrypt data as it is sent and received from the server. Currently only AES is is supported. - ------- -RETURN ------- - +RETURN VALUE +------------ A value of type :type:`memcached_return_t` is returned On success that value will be `MEMCACHED_SUCCESS`. Use :func:`memcached_strerror` to translate this value to a printable string. - - --------- SEE ALSO --------