.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.3 manpage writer.
.
.
.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" "Mar 07, 2026" "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(memcached_st \%<#\:_CPPv412memcached_st> *ptr, char *key, size_t *key_length, size_t *value_length, uint32_t *flags, memcached_return_t \%<#\:_CPPv418memcached_return_t> *error) 
Deprecated since version 0.50: Use \fBmemcached_fetch_result()\fP \%<#\:_CPPv422memcached_fetch_resultP12memcached_stP19memcached_result_stP18memcached_return_t> instead.

.UNINDENT
.SH DESCRIPTION
.sp
\fBmemcached_fetch()\fP is used to fetch an individual value from the server.
\fBmemcached_mget()\fP \%<#\:_CPPv414memcached_mgetP12memcached_stPPCKcPK6size_t6size_t> 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 \fBmemcached_return_t\fP \%<#\:_CPPv418memcached_return_t> pointer to hold any error.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The object will be returned upon success and NULL will be returned on failure.
.sp
\fBMEMCACHED_END\fP \%<#\:_CPPv4N18memcached_return_t13MEMCACHED_ENDE> is returned by the error value when all objects that have been found are returned.
The final value upon \fBMEMCACHED_END\fP \%<#\:_CPPv4N18memcached_return_t13MEMCACHED_ENDE> is a NULL pointer.
.sp
Values returned by \fBmemcached_fetch()\fP must be freed by the caller.
.sp
All of the above functions are not tested when the
\fBMEMCACHED_BEHAVIOR_USE_UDP\fP \%<#\:_CPPv4N20memcached_behavior_t26MEMCACHED_BEHAVIOR_USE_UDPE> has been set. Executing any of these
functions with this behavior on will result in \fBMEMCACHED_NOT_SUPPORTED\fP \%<#\:_CPPv4N18memcached_return_t23MEMCACHED_NOT_SUPPORTEDE>
being returned, or for those functions which do not return a
\fBmemcached_return_t\fP \%<#\:_CPPv418memcached_return_t>, the error function parameter will
be set to \fBMEMCACHED_NOT_SUPPORTED\fP \%<#\:_CPPv4N18memcached_return_t23MEMCACHED_NOT_SUPPORTEDE>\&.
.SH RETURN VALUE
.sp
\fBmemcached_fetch()\fP sets error to
to \fBMEMCACHED_END\fP \%<#\:_CPPv4N18memcached_return_t13MEMCACHED_ENDE> upon successful conclusion.
.sp
\fBMEMCACHED_NOTFOUND\fP \%<#\:_CPPv4N18memcached_return_t18MEMCACHED_NOTFOUNDE> will be return if no keys at all were found.
.sp
\fBMEMCACHED_KEY_TOO_BIG\fP \%<#\:_CPPv4N18memcached_return_t21MEMCACHED_KEY_TOO_BIGE> is set to error whenever \fBmemcached_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
\fBmemcached(1) \%<https://\:linux\:.die\:.net/\:man/\:1/\:memcached>\fP
\fBlibmemcached(3) \%<https://\:linux\:.die\:.net/\:man/\:3/\:libmemcached>\fP
\fBmemcached_strerror(3) \%<https://\:linux\:.die\:.net/\:man/\:3/\:memcached_strerror>\fP
\fBmemcached_fetch_result(3) \%<https://\:linux\:.die\:.net/\:man/\:3/\:memcached_fetch_result>\fP
.\" End of generated man page.