MEMCACHED_RESULT_CREATE(3)

💖 MEMCACHED_RESULT_CREATE 💖

okay bestie, sit down, hydrate, because we're talking about result sets in libmemcached-awesome and honestly? it's giving organized. this is the <libmemcached/memcached.h> girlies' page, section 3 of the manual, and no cap it's lowkey one of the most useful things in the whole library. let's get into it 🫶

---

✨ NAME ✨

memcached_result_create — working with result sets 🎀

---

✨ SYNOPSIS ✨

#include <libmemcached/memcached.h>

Compile and link with -lmemcachedutil -lmemcached

typedef struct memcached_result_st memcached_result_st

---

🌸 memcached_result_create()

memcached_result_st *memcached_result_create(memcached_st *ptr,
memcached_result_st *result)

Parameters 💅

• ptr — pointer to initialized memcached_st struct
• result — pointer to an memcached_result_st instance to initialize, or nullptr to allocate a brand new instance

Returns ✨

pointer to initialized memcached_result_st instance

---

🌸 memcached_result_free()

void memcached_result_free(memcached_result_st *result)

Parameters 💅

• result — pointer to initialized memcached_result_st struct

---

🌸 memcached_result_key_value()

const char *memcached_result_key_value(memcached_result_st *result)

Parameters 💅

• result — pointer to initialized memcached_result_st struct

Returns ✨

the key value associated with the current result object

---

🌸 memcached_result_key_length()

size_t memcached_result_key_length(const memcached_result_st *result)

Parameters 💅

• result — pointer to initialized memcached_result_st struct

Returns ✨

the key length associated with the current result object

---

🌸 memcached_result_value()

const char *memcached_result_value(memcached_result_st *result)

Parameters 💅

• result — pointer to initialized memcached_result_st struct

Returns ✨

the result value associated with the current result object

---

🌸 memcached_result_take_value()

char *memcached_result_take_value(memcached_result_st *result)

Parameters 💅

• result — pointer to initialized memcached_result_st struct

Returns ✨

the result value associated with the current result object

---

🌸 memcached_result_length()

size_t memcached_result_length(const memcached_result_st *result)

Parameters 💅

• result — pointer to initialized memcached_result_st struct

Returns ✨

the result length associated with the current result object

---

🌸 memcached_result_flags()

uint32_t memcached_result_flags(const memcached_result_st *result)

Parameters 💅

• result — pointer to initialized memcached_result_st struct

Returns ✨

the flags associated with the current result object

---

🌸 memcached_result_cas()

uint64_t memcached_result_cas(const memcached_result_st *result)

Parameters 💅

• result — pointer to initialized memcached_result_st struct

Returns ✨

the cas associated with the current result object

---

🌸 memcached_result_set_value()

memcached_return_t memcached_result_set_value(memcached_result_st
*result, const char *value, size_t length)

Parameters 💅

• result — pointer to initialized memcached_result_st struct
• value — byte array to set the value of the current result object to
• length — the length of value, with no terminating zero in there

Returns ✨

memcached_return_t indicating success

---

🌸 memcached_result_set_flags()

void memcached_result_set_flags(memcached_result_st *result, uint32_t
flags)

Parameters 💅

• result — pointer to initialized memcached_result_st struct
• flags — a new value for the flags field

---

🌸 memcached_result_set_expiration()

void memcached_result_set_expiration(memcached_result_st *result, time_t
expiration)

Parameters 💅

• result — pointer to initialized memcached_result_st struct
• expiration — a new value for the expiration field

---

✨ DESCRIPTION ✨

so here's the tea ☕ libmemcached can optionally hand you back a memcached_result_st that acts as a whole result object. and bestie, result objects are lowkey superior to the plain character pointer return values — they're forward compatible with new return items that future memcached servers might implement (the best example we have right now? the CAS return item, iconic). plus you can reuse the structures, which means fewer calls to malloc(3). so yeah, it's suggested that you use result objects over char * return functions. periodt. 💅

the structure of memcached_result_st is encapsulated — you should NOT be writing code that reaches directly into its members. hands off the internals, bestie. 🙈

memcached_result_create() will either allocate memory for a memcached_result_st or initialize a structure that you passed to it. your call, main character. ✨

memcached_result_free() deallocates any memory attached to the structure. and if the structure itself was also allocated? it deallocates that too. double cleanup, we love to see it. 🧹

memcached_result_key_value() returns the key value associated with the current result object. 🔑

memcached_result_key_length() returns the key length associated with the current result object. 📏

memcached_result_value() returns the result value associated with the current result object. 🎁

memcached_result_take_value() returns and hands over the result value associated with the current result object. now listen — you must call free(3) to release this value, unless you made use of a custom allocator. and if you DID use a custom allocator, you need to create your own custom free() to release it. iykyk. 🫶

memcached_result_length() returns the result length associated with the current result object. 📐

memcached_result_flags() returns the flags associated with the current result object. 🚩

memcached_result_cas() returns the cas associated with the current result object. heads up though: this value will only be available if the server tests it. no server check, no cas, no drama. 💀

memcached_result_set_value() takes a byte array and a size and sets the result to this value. this function is used for trigger responses. ⚡

memcached_result_set_flags() takes a result structure and stores a new value for the flags field. 🌈

memcached_result_set_expiration() takes a result structure and stores a new value for the expiration field — and psst, this one is only used by read through triggers. ⏰

---

✨ RETURN VALUE ✨

varies, bestie — see the particular functions above. 💫

but the one universal rule? all structures must have memcached_result_free() called on them for cleanup purposes. failure to do this will result in leaked memory. not a vibe, not the moment, don't do it. 😭

---

✨ SEE ALSO ✨

• memcached(1)
• libmemcached(3)
• memcached_strerror(3)
• memcached_memory_allocators(3)

---

and that's the whole page, bestie! 🦋 this one came from libmemcached-awesome, version 1.1, dated Jul 24, 2025 — go forth and manage your result sets responsibly, and remember: free your structures or they will haunt you. slay 💖✨🎀