.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "MEMCACHED_TOUCH_BY_KEY" "3" "May 01, 2024" "1.1" "libmemcached-awesome"
.SH NAME
memcached_touch_by_key \- libmemcached Documentation
.SH SYNOPSIS
.INDENT 0.0
.TP
.B #include <libmemcached/memcached.h>
Compile and link with \-lmemcached
.UNINDENT
.INDENT 0.0
.TP
.B \X'tty: link #_CPPv418memcached_return_t'\fI\%memcached_return_t\fP\X'tty: link' memcached_touch(\X'tty: link #_CPPv412memcached_st'\fI\%memcached_st\fP\X'tty: link' *ptr, const char *key, size_t key_length, time_t expiration) 
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBptr\fP \-\- pointer to initialized \X'tty: link #_CPPv412memcached_st'\fI\%memcached_st\fP\X'tty: link' struct
.IP \(bu 2
\fBkey\fP \-\- the key to touch
.IP \(bu 2
\fBkey_length\fP \-\- the length of \fI\%key\fP without any terminating zero
.IP \(bu 2
\fBexpiration\fP \-\- new expiration as a unix timestamp or as relative expiration time in seconds
.UNINDENT
.TP
.B Returns
\X'tty: link #_CPPv418memcached_return_t'\fI\%memcached_return_t\fP\X'tty: link' indicating success
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \X'tty: link #_CPPv418memcached_return_t'\fI\%memcached_return_t\fP\X'tty: link' memcached_touch_by_key(\X'tty: link #_CPPv412memcached_st'\fI\%memcached_st\fP\X'tty: link' *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration) 
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBptr\fP \-\- pointer to initialized \X'tty: link #_CPPv412memcached_st'\fI\%memcached_st\fP\X'tty: link' struct
.IP \(bu 2
\fBgroup_key\fP \-\- the \fI\%key\fP namespace
.IP \(bu 2
\fBgroup_key_length\fP \-\- the length of \fI\%group_key\fP without any terminating zero
.IP \(bu 2
\fBkey\fP \-\- the key to touch
.IP \(bu 2
\fBkey_length\fP \-\- the length of \fI\%key\fP without any terminating zero
.IP \(bu 2
\fBexpiration\fP \-\- new expiration as a unix timestamp or as relative expiration time in seconds
.UNINDENT
.TP
.B Returns
\X'tty: link #_CPPv418memcached_return_t'\fI\%memcached_return_t\fP\X'tty: link' indicating success
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
\fI\%memcached_touch()\fP is used to update the expiration time on an existing key.
\fI\%memcached_touch_by_key()\fP works the same, but it takes a master key
to find the given value.
.SH RETURN VALUE
.sp
A value of type \X'tty: link #_CPPv418memcached_return_t'\fI\%memcached_return_t\fP\X'tty: link' is returned.
On success that value will be \X'tty: link #_CPPv4N18memcached_return_t17MEMCACHED_SUCCESSE'\fI\%MEMCACHED_SUCCESS\fP\X'tty: link'\&.
Use \X'tty: link #_CPPv418memcached_strerrorP12memcached_st18memcached_return_t'\fI\%memcached_strerror()\fP\X'tty: link' to translate this value to a printable
string.
.SH SEE ALSO
.sp
\fB\X'tty: link https://linux.die.net/man/1/memcached'\fI\%memcached(1)\fP\X'tty: link'\fP
\fB\X'tty: link https://linux.die.net/man/3/libmemcached'\fI\%libmemcached(3)\fP\X'tty: link'\fP
\fB\X'tty: link https://linux.die.net/man/3/memcached_strerror'\fI\%memcached_strerror(3)\fP\X'tty: link'\fP
.\" Generated by docutils manpage writer.
.