.\" 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_FETCH" "3" "May 01, 2024" "1.1" "libmemcached-awesome"
.SH NAME
memcached_fetch \- Retrieving data from the server
.SH SYNOPSIS
.INDENT 0.0
.TP
.B #include <libmemcached/memcached.h>
Compile and link with \-lmemcached
.UNINDENT
.INDENT 0.0
.TP
.B char *memcached_fetch(\X'tty: link #_CPPv412memcached_st'\fI\%memcached_st\fP\X'tty: link' *ptr, char *key, size_t *key_length, size_t *value_length, uint32_t *flags, \X'tty: link #_CPPv418memcached_return_t'\fI\%memcached_return_t\fP\X'tty: link' *error) 
Deprecated since version 0.50: Use \X'tty: link #_CPPv422memcached_fetch_resultP12memcached_stP19memcached_result_stP18memcached_return_t'\fI\%memcached_fetch_result()\fP\X'tty: link' instead.

.UNINDENT
.SH DESCRIPTION
.sp
\fI\%memcached_fetch()\fP is used to fetch an individual value from the server.
\X'tty: link #_CPPv414memcached_mgetP12memcached_stPPCKcPK6size_t6size_t'\fI\%memcached_mget()\fP\X'tty: link' must always be called before using this method.
You must pass in a key and its length to fetch the object.
.sp
You must supply three pointer variables which will give you the state of the returned
object:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
A \fBuint32_t\fP pointer to contain whatever flags you stored with the value,
.IP \(bu 2
a \fBsize_t\fP pointer which will be filled with size of of the object, and
.IP \(bu 2
a \X'tty: link #_CPPv418memcached_return_t'\fI\%memcached_return_t\fP\X'tty: link' pointer to hold any error.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The object will be returned upon success and NULL will be returned on failure.
.sp
\X'tty: link #_CPPv4N18memcached_return_t13MEMCACHED_ENDE'\fI\%MEMCACHED_END\fP\X'tty: link' is returned by the error value when all objects that have been found are returned.
The final value upon \X'tty: link #_CPPv4N18memcached_return_t13MEMCACHED_ENDE'\fI\%MEMCACHED_END\fP\X'tty: link' is a NULL pointer.
.sp
Values returned by \fI\%memcached_fetch()\fP must be freed by the caller.
.sp
All of the above functions are not tested when the
\X'tty: link #_CPPv4N20memcached_behavior_t26MEMCACHED_BEHAVIOR_USE_UDPE'\fI\%MEMCACHED_BEHAVIOR_USE_UDP\fP\X'tty: link' has been set. Executing any of these
functions with this behavior on will result in \X'tty: link #_CPPv4N18memcached_return_t23MEMCACHED_NOT_SUPPORTEDE'\fI\%MEMCACHED_NOT_SUPPORTED\fP\X'tty: link'
being returned, or for those functions which do not return a
\X'tty: link #_CPPv418memcached_return_t'\fI\%memcached_return_t\fP\X'tty: link', the error function parameter will
be set to \X'tty: link #_CPPv4N18memcached_return_t23MEMCACHED_NOT_SUPPORTEDE'\fI\%MEMCACHED_NOT_SUPPORTED\fP\X'tty: link'\&.
.SH RETURN VALUE
.sp
\fI\%memcached_fetch()\fP sets error to
to \X'tty: link #_CPPv4N18memcached_return_t13MEMCACHED_ENDE'\fI\%MEMCACHED_END\fP\X'tty: link' upon successful conclusion.
.sp
\X'tty: link #_CPPv4N18memcached_return_t18MEMCACHED_NOTFOUNDE'\fI\%MEMCACHED_NOTFOUND\fP\X'tty: link' will be return if no keys at all were found.
.sp
\X'tty: link #_CPPv4N18memcached_return_t21MEMCACHED_KEY_TOO_BIGE'\fI\%MEMCACHED_KEY_TOO_BIG\fP\X'tty: link' is set to error whenever \fI\%memcached_fetch()\fP was used
and the key was set larger then \fBMEMCACHED_MAX_KEY\fP, which was the largest
key allowed for the original memcached ascii server.
.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
\fB\X'tty: link https://linux.die.net/man/3/memcached_fetch_result'\fI\%memcached_fetch_result(3)\fP\X'tty: link'\fP
.\" Generated by docutils manpage writer.
.