MEMCACHED_RESULT_KEY_LENGTH(3)

✨ memcached_result_key_length(3) ✨

okay bestie, welcome to the libmemcached-awesome result-set glow-up 💖 this is the memcached_result_key_length(3) page and yes it covers the whole result-set friend group, not just the one in the title. buckle up 🎀

---

💫 NAME 💫

memcached_result_key_length — working with result sets (yes that's the whole vibe, it's a whole squad of functions)

---

🌸 SYNOPSIS 🌸

#include <libmemcached/memcached.h>

Compile and link with -lmemcachedutil -lmemcached — do NOT forget the util one, she matters 💅

typedef struct memcached_result_st memcached_result_st

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 new instance

Returns pointer to initialized memcached_result_st instance ✨

void memcached_result_free(memcached_result_st *result)

Parameters

• result -- pointer to initialized memcached_result_st struct

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 🔑

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 📏

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 💖

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 🫴

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 📐

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 🚩

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_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 wothout any terminating zero (yes, "wothout" — that's how the original spells it, and we keep it, no cap 💀)

Returns memcached_return_t indicating success ✅

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

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, bestie: libmemcached can optionally hand you back a memcached_result_st that acts as a result object. and like, result objects are genuinely the upgrade — they have added benefits over the character pointer return values, because they're forward compatible with new return items that future memcached servers may implement. the best current example of this is the CAS return item, iconic behavior honestly 👑

the structures can also be reused, which will save on calls to malloc(3). it is suggested that you use result objects over char * return functions. periodt.

ok but listen — the structure of memcached_result_st has been encapsulated, so you should not write code directly accessing members of the structure. do not do it. that's not your business, that's her business 🙈

memcached_result_create() will either allocate memory for a memcached_result_st or will initialize a structure passed to it.

memcached_result_free() will deallocate any memory attached to the structure. if the structure was also allocated, it will deallocate it too. she's thorough 💅

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. you must call free(3) 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. so like, don't forget or it's leaking, and leaking is not the vibe 😭

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. this value will only be available if the server tests it. no server test, no cas, sorry bestie 🤷

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 (this is only used by read through triggers).

---

🌈 RETURN VALUE 🌈

Varies, see particular functions. All structures must have memcached_result_free() called on them for cleanup purposes. Failure to do this will result in leaked memory. every single one. don't skip it. it's giving memory leak and nobody wants that 💀

---

⭐ SEE ALSO ⭐

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

---

mwah 💋 that's the page! this one is from libmemcached-awesome, version 1.1, dated Jul 24, 2025 — go forth and manage your result sets responsibly, bestie 🫶✨💖