brlapi_handles(3)

💖 brlapi_handles — bestie, it's the BrlAPI handles page 💖

okay so real talk, this is brlapi_handles(3) from the Library Functions Manual, and it's genuinely shorter than my attention span but it's SO important, so stay with me 🫶

---

✨ NAME ✨

brlapi_handles — BrlAPI handles. that's it. that's the whole vibe check. handles. 👑

---

🌸 SYNOPSIS 🌸

🎀 Typedefs

typedef struct brlapi_handle_t brlapi_handle_t

🎀 Functions

size_t BRLAPI_STDCALL brlapi_getHandleSize (void)

---

🦋 DETAILED DESCRIPTION 🦋

okay so here's the tea, and it's actually kind of iconic: every single function that BrlAPI gives you comes in TWO versions. not one. two. like a pop star with a deluxe album 💅

1. one version whose name is prefixed by brlapi_ — this one's for clients that only open one simultaneous connection with BrlAPI. and bestie, that's the most frequent case, no cap.
2. another version whose name is prefixed by brlapi__ — this one's for clients that wanna open more than one connection to BrlAPI. multiple connections? greedy. love that for you. 💜

so a function called brlapi__foo gets used in exactly the same way as its brlapi_foo counterpart... with one lil difference: it takes an additional argument, and it's the first one, and that argument is a handle. the handle lets the client point at a specific connection, kind of like how file descriptors do. same energy, different body 🌈

💀 now for the important part, listen up: if you wanna check that your code is not erroneously using brlapi_foo functions, define BRLAPI_NO_SINGLE_SESSION before including <brlapi.h>. do that and it will disable the declaration of all single session functions. gone. not invited. 🙈

---

🎀 TYPEDEF DOCUMENTATION 🎀

⭐ typedef struct brlapi_handle_t brlapi_handle_t

the type for BrlAPI handles. the moment. the legend. 🫶

---

💅 FUNCTION DOCUMENTATION 💅

⭐ size_t BRLAPI_STDCALL brlapi_getHandleSize (void )

this one returns the size of an object of type brlapi_handle_t, measured in bytes. that's it, that's the whole function, and honestly? she ate. ✨

References BRLAPI_STDCALL.

---

👑 AUTHOR 👑

Generated automatically by Doxygen for BrlAPI from the source code. (not a human, not a girlie, just a robot doing its best 🧚)

---

and that's the whole page, bestie!! this little legend comes to you courtesy of BrlAPI, Version 0.8 — go forth and handle your handles responsibly 💖✨🎀🦋🌸