.\" 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_RESULT_VALUE" "3" "Feb 01, 2024" "1.1" "libmemcached-awesome"
.SH NAME
memcached_result_value \- Working with result sets
.SH SYNOPSIS
.INDENT 0.0
.TP
.B #include <libmemcached/memcached.h>
Compile and link with \-lmemcachedutil \-lmemcached
.UNINDENT
.INDENT 0.0
.TP
.B typedef struct \fI\%memcached_result_st\fP memcached_result_st 
.UNINDENT
.INDENT 0.0
.TP
.B \fI\%memcached_result_st\fP *memcached_result_create(\fI\%memcached_st\fP *ptr, \fI\%memcached_result_st\fP *result) 
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBptr\fP \-\- pointer to initialized \fI\%memcached_st\fP struct
.IP \(bu 2
\fBresult\fP \-\- pointer to an \fI\%memcached_result_st\fP instance to initialize or
nullptr to allocate a new instance
.UNINDENT
.TP
.B Returns
pointer to initialized \fI\%memcached_result_st\fP instance
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B void memcached_result_free(\fI\%memcached_result_st\fP *result) 
.INDENT 7.0
.TP
.B Parameters
\fBresult\fP \-\- pointer to initialized \fI\%memcached_result_st\fP struct
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B const char *memcached_result_key_value(\fI\%memcached_result_st\fP *result) 
.INDENT 7.0
.TP
.B Parameters
\fBresult\fP \-\- pointer to initialized \fI\%memcached_result_st\fP struct
.TP
.B Returns
the key value associated with the current result object
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B size_t memcached_result_key_length(const \fI\%memcached_result_st\fP *result) 
.INDENT 7.0
.TP
.B Parameters
\fBresult\fP \-\- pointer to initialized \fI\%memcached_result_st\fP struct
.TP
.B Returns
the key length associated with the current result object
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B const char *memcached_result_value(\fI\%memcached_result_st\fP *result) 
.INDENT 7.0
.TP
.B Parameters
\fBresult\fP \-\- pointer to initialized \fI\%memcached_result_st\fP struct
.TP
.B Returns
the result value associated with the current result object
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B char *memcached_result_take_value(\fI\%memcached_result_st\fP *result) 
.INDENT 7.0
.TP
.B Parameters
\fBresult\fP \-\- pointer to initialized \fI\%memcached_result_st\fP struct
.TP
.B Returns
the result value associated with the current result object
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B size_t memcached_result_length(const \fI\%memcached_result_st\fP *result) 
.INDENT 7.0
.TP
.B Parameters
\fBresult\fP \-\- pointer to initialized \fI\%memcached_result_st\fP struct
.TP
.B Returns
the result length associated with the current result object
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B uint32_t memcached_result_flags(const \fI\%memcached_result_st\fP *result) 
.INDENT 7.0
.TP
.B Parameters
\fBresult\fP \-\- pointer to initialized \fI\%memcached_result_st\fP struct
.TP
.B Returns
the flags associated with the current result object
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B uint64_t memcached_result_cas(const \fI\%memcached_result_st\fP *result) 
.INDENT 7.0
.TP
.B Parameters
\fBresult\fP \-\- pointer to initialized \fI\%memcached_result_st\fP struct
.TP
.B Returns
the cas associated with the current result object
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \fI\%memcached_return_t\fP memcached_result_set_value(\fI\%memcached_result_st\fP *result, const char *value, size_t length) 
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBresult\fP \-\- pointer to initialized \fI\%memcached_result_st\fP struct
.IP \(bu 2
\fBvalue\fP \-\- byte array to set the value of the current result object to
.IP \(bu 2
\fBlength\fP \-\- the length of \fI\%value\fP wothout any terminating zero
.UNINDENT
.TP
.B Returns
\fI\%memcached_return_t\fP indicating success
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B void memcached_result_set_flags(\fI\%memcached_result_st\fP *result, uint32_t flags) 
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBresult\fP \-\- pointer to initialized \fI\%memcached_result_st\fP struct
.IP \(bu 2
\fBflags\fP \-\- a new value for the flags field
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B void memcached_result_set_expiration(\fI\%memcached_result_st\fP *result, time_t expiration) 
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBresult\fP \-\- pointer to initialized \fI\%memcached_result_st\fP struct
.IP \(bu 2
\fBexpiration\fP \-\- a new value for the expiration field
.UNINDENT
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
\fBlibmemcached\fP can optionally return a \fI\%memcached_result_st\fP which
acts as a result object. The result objects have added benefits over the
character pointer return values, in that they are forward compatible with new
return items that future memcached servers may implement (the best current
example of this is the CAS return item). The structures can also be reused,
which will save on calls to \fBmalloc(3)\fP\&. It is suggested that you use
result objects over char * return functions.
.sp
The structure of \fI\%memcached_result_st\fP has been encapsulated, you should
not write code directly accessing members of the structure.
.sp
\fI\%memcached_result_create()\fP will either allocate memory for a
\fI\%memcached_result_st\fP or will initialize a structure passed to it.
.sp
\fI\%memcached_result_free()\fP will deallocate any memory attached to the
structure. If the structure was also allocated, it will deallocate it.
.sp
\fI\%memcached_result_key_value()\fP returns the key value associated with the
current result object.
.sp
\fI\%memcached_result_key_length()\fP returns the key length associated with
the current result object.
.sp
\fI\%memcached_result_value()\fP returns the result value associated with the
current result object.
.sp
\fI\%memcached_result_take_value()\fP returns and hands over the result value
associated with the current result object. You must call \fBfree(3)\fP to
release this value, unless you have made use of a custom allocator. Use of a
custom allocator requires that you create your own custom free() to release it.
.sp
\fI\%memcached_result_length()\fP returns the result length associated with
the current result object.
.sp
\fI\%memcached_result_flags()\fP returns the flags associated with the
current result object.
.sp
\fI\%memcached_result_cas()\fP returns the cas associated with the
current result object. This value will only be available if the server
tests it.
.sp
\fI\%memcached_result_set_value()\fP takes a byte array and a size and sets
the result to this value. This function is used for trigger responses.
.sp
\fI\%memcached_result_set_flags()\fP takes a result structure and stores a new
value for the flags field.
.sp
\fI\%memcached_result_set_expiration()\fP takes a result structure and stores
a new value for the expiration field (this is only used by read through
triggers).
.SH RETURN VALUE
.sp
Varies, see particular functions. All structures must have
\fI\%memcached_result_free()\fP called on them for cleanup purposes. Failure
to do this will result in leaked memory.
.SH SEE ALSO
.sp
\fBmemcached(1)\fP
\fBlibmemcached(3)\fP
\fBmemcached_strerror(3)\fP
\fBmemcached_memory_allocators(3)\fP
.\" Generated by docutils manpage writer.
.