QB_ARRAY_INDEX(3)

✨ QB_ARRAY_INDEX(3) ✨

okay bestie, so this is a page from the libqb Programmer's Manual and it's about one little function that goes and grabs you a thing. it's giving very specific, very useful, no cap. 🎀

---

💖 NAME 💖

qb_array_index — Get an element at a particular index.

like. that's it. that's the job. you want the thing at position idx? boom, this function has you. 🫶

---

🌸 SYNOPSIS 🌸

first things first, you gotta pull in the header, she's right here:

#include <qb/qbarray.h>

and then the actual call looks like this, verbatim, don't come for me:

int32_t qb_array_index(
    qb_array_t   *a,            /* array instance */
    /*
     * the index, valid in [0, QB_ARRAY_MAX_ELEMENTS) range
     */
    int32_t       idx,
    void        **element_out   /* the pointer to the element data */
);

see how it returns an int32_t? clock that. we'll get to what the numbers mean in a sec. ⭐

---

🦋 PARAMS 🦋

the tea on the arguments, one by one, because we don't gatekeep here:

• a — array instance. it's your array. the actual one. the whole vibe. you bring her, she's the one holding the elements.
• idx — the index, valid in [0, QB_ARRAY_MAX_ELEMENTS) range. so it has to be at least 0, and it has to be less than QB_ARRAY_MAX_ELEMENTS. that's a half-open range, bestie, the ) is doing so much work. 👑
• element_out — the pointer to the element data. this is where the function hands you back the pointer to the element you asked for. an output param, she's a void **, so she points at a pointer. that's just how it is. 💅

---

🌈 DESCRIPTION 🌈

so… the description section is literally empty in the original. like, nothing. zero words. it's giving silence. 😭

not me adding anything that isn't there, though — the manpage says nothing here, so I say nothing here. the function name and the params are doing all the talking. the NAME line already told you the whole plot: it gets an element at a particular index. periodt. ✨

---

🎀 RETURN VALUE 🎀

here's the important bit, don't scroll past this:

(0 == success, else -errno)

so if you get back a 0? 🎉 slay, you win, element retrieved, main character energy. if you get back anything else, it's -errno — a negated errno value, so you know what went wrong, just flipped into the negative. check it, always. no cap.

---

💜 SEE ALSO 💜

the whole friend group, go say hi:

• qb_array_elems_per_bin_get(3)
• qb_array_new_bin_cb_set(3)
• qb_array_create(3)
• qb_array_grow(3)
• qb_array_num_bins_get(3)
• qb_array_create_2(3)
• qb_array_free(3)

that's the roster. iykyk. 🧚

---

🌟 COPYRIGHT 🌟

Copyright (C) 2010-2020 Red Hat, Inc.

---

and that's the whole page, bestie!! 💖 this one came out of libqb and it's dated 2025-09-16, so if you're reading it later than that, hi from the past, hope the array indexing is going great. now go get that element. you got this. 🦋✨