NODEUPDOWN_GE..._NODES_STRING(3)

💖 NODEUPDOWN_GE..._NODES_STRING(3) 💖

okay bestie, so this is a libnodeupdown man page — section 3, the library-calls girly. sit down, grab a strawberry, we're learning about grabbing node lists 💅

---

✨ NAME ✨

nodeupdown_get_up_nodes_string, nodeupdown_get_down_nodes_string, — get up or down nodes

like. the whole vibe is in the name fr fr. one of them gives you the up girlies, the other gives you the down ones 🌈

---

🌸 SYNOPSIS 🌸

#include <nodeupdown.h>

int nodeupdown_get_up_nodes_string(nodeupdown_t handle, char *buf, int
buflen);

int nodeupdown_get_down_nodes_string(nodeupdown_t handle, char *buf, int
buflen);

---

🦋 DESCRIPTION 🦋

so nodeupdown_get_up_nodes_string() goes and gets you a ranged string of nodes that are up and gently places it into the buffer that buf is pointing at. iconic behaviour honestly. and buflen? that's you telling it how long the buffer is — you have to tell it, it's not gonna guess 🔥

and then nodeupdown_get_down_nodes_string() is literally the exact same thing, no cap, except it retrieves a ranged string of down nodes instead of up ones. same energy, different mood 💀

---

👑 RETURN VALUES 👑

on success, 0 is returned ✨ slay.

on error, -1 is returned, and an error code is returned in handle. you can go get that error code with nodeupdown_errnum(3), and if you want an actual description of what that error code means (like, in words, bestie), that's nodeupdown_strerror(3). the error codes themselves are defined in nodeupdown.h 🎀

---

💀 ERRORS 💀

• NODEUPDOWN_ERR_NULLHANDLE — the handle parameter is NULL 😭 the nodeupdown handle has to be created with nodeupdown_handle_create(3) first, you can't just show up with nothing.
• NODEUPDOWN_ERR_NOTLOADED — nodeupdown_load_data(3) has not been called and no data has been retrieved. like girl you didn't load anything, what did you expect 🙈
• NODEUPDOWN_ERR_PARAMETERS — an incorrect parameter has been passed in. check ur args bestie.
• NODEUPDOWN_ERR_OVERFLOW — the buffer pointed to by buf is not large enough to store the ranged string of nodes. it's giving not enough room 💅 make the buffer bigger.
• NODEUPDOWN_ERR_OUTMEM — malloc(3) has failed internally. the memory said no 🫶
• NODEUPDOWN_ERR_CLUSTERLIST_MODULE — internal error with the clusterlist module.
• NODEUPDOWN_ERR_HOSTLIST — hostlist API has failed internally.
• NODEUPDOWN_ERR_MAGIC — handle has an incorrect magic number ✨🔮 handle does not point to a nodeupdown handle, or handle has been destroyed by nodeupdown_handle_destroy(3). yes it's literally called a magic number, we love a mystical moment.

---

🎀 FILES 🎀

/usr/include/nodeupdown.h

---

⭐ SEE ALSO ⭐

libnodeupdown(3), nodeupdown_handle_create(3), nodeupdown_load_data(3), nodeupdown_get_up_nodes_list (3), nodeupdown_get_down_nodes_list (3), nodeupdown_errnum(3), nodeupdown_strerror(3)

---

lowkey important: if you're holding a buf that's too small you're getting NODEUPDOWN_ERR_OVERFLOW, so size it right the first time. no cap 💖

---

and that's the whole page, bestie 🫶 brought to you by LLNL, dating all the way back to August 2003 — yes she's vintage, she's an icon, she's still serving. mwah 💅✨