EC_INTERACT_GET_HELPS(3)

✨ EC_INTERACT_GET_HELPS(3) ✨

okay bestie, welcome to the Libecoli Programmer's Manual 💖 this one is ec_interact_get_helps — it's a little function from the 3 section and it's literally here to hand you the contextual helps for whatever line you're chillin' on. yes queen, help for your help 🎀

---

🌸 NAME 🌸

ec_interact_get_helps — Get contextual helps from the current line.

like. the vibes are: you give it a line, it gives you the helps. no cap ✨

---

🦋 SYNOPSIS 🦋

#include <ecoli/interact.h>

ssize_t ec_interact_get_helps(
    const struct ec_node       *node,       /* The pointer to the sh_lex grammar node. */
    const char                 *line,       /* The line from which to get help. */
    /*
     * The pointer where the helps array will be returned.
     */
    struct ec_interact_help   **helps_out
);

so you pull in the header, and you pass three things: the node (that's the pointer to the sh_lex grammar node, the grammar girlie herself 💅), the line (the line you want help from), and helps_out (the pointer where the helps array gets returned, i.e. where the good stuff lands 🫶).

---

🎀 STRUCTURES 🎀

A structure describing a contextual help. it's giving very minimal, and honestly? iconic.

struct ec_interact_help {
};

that's it. that's the struct. it describes a contextual help and it contains exactly nothing, and we respect it for that 💀✨

---

👑 RETURN VALUE 👑

• the size of the array on success — and by success we mean >= 0, so yes, zero counts, she's valid 🌈
• -1 on error 😭

periodt.

---

🔥 SEE ALSO 🔥

the whole friend group, fr fr — go read these too, they're all part of the same clique:

• ec_interact_get_completions(3)
• ec_interact_print_helps(3)
• ec_interact_print_error_helps(3)
• ec_interact_print_cols(3)
• ec_interact_set_help(3)
• ec_interact_append_chars(3)
• ec_interact_set_desc(3)
• ec_interact_get_callback(3)
• ec_interact_set_callback(3)
• ec_interact_get_error_helps(3)
• ec_interact_free_completions(3)
• ec_interact_free_helps(3)

iykyk 💜

---

🧚 COPYRIGHT 🧚

Copyright (C) 2010-2026 Olivier Matz, Robin Jarry.

---

and that's the whole page bestie, you ate 🍓 this was libecoli, dated 2026-06-11, and the manual page is EC_INTERACT_GET_HELPS(3) — mwah, go forth and get those contextual helps 💖✨🎀