.\" 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" "Mar 06, 2023" "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(\fI\%memcached_st\fP  *ptr, char  *key, size_t  *key_length, size_t  *value_length, uint32_t  *flags, \fI\%memcached_return_t\fP  *error) 
Deprecated since version 0.50: Use \fI\%memcached_fetch_result()\fP instead.

.UNINDENT
.SH DESCRIPTION
.sp
\fI\%memcached_fetch()\fP is used to fetch an individual value from the server.
\fI\%memcached_mget()\fP 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 \fI\%memcached_return_t\fP pointer to hold any error.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The object will be returned upon success and NULL will be returned on failure.
.sp
\fI\%MEMCACHED_END\fP is returned by the error value when all objects that have been found are returned.
The final value upon \fI\%MEMCACHED_END\fP 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
\fI\%MEMCACHED_BEHAVIOR_USE_UDP\fP has been set. Executing any of these
functions with this behavior on will result in \fI\%MEMCACHED_NOT_SUPPORTED\fP
being returned, or for those functions which do not return a
\fI\%memcached_return_t\fP, the error function parameter will
be set to \fI\%MEMCACHED_NOT_SUPPORTED\fP\&.
.SH RETURN VALUE
.sp
\fI\%memcached_fetch()\fP sets error to
to \fI\%MEMCACHED_END\fP upon successful conclusion.
.sp
\fI\%MEMCACHED_NOTFOUND\fP will be return if no keys at all were found.
.sp
\fI\%MEMCACHED_KEY_TOO_BIG\fP 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
\fBmemcached(1)\fP
\fBlibmemcached(3)\fP
\fBmemcached_strerror(3)\fP
\fBmemcached_fetch_result(3)\fP
.\" Generated by docutils manpage writer.
.