brlapi_writeArguments_t(3)

💖 brlapi_writeArguments_t 💖

okay so bestie, welcome to the brlapi_writeArguments_t page from the Library Functions Manual 💅 this is a struct, she's a whole vibe, and she's literally the little bundle of arguments you hand over to brlapi_write(). sit down, hydrate, let's go 🫶

---

✨ NAME ✨

brlapi_writeArguments_t — the struct of dreams, the argument holder, the girl who carries everything you need to pass to brlapi_write()

---

🌸 SYNOPSIS 🌸

#include <brlapi.h>

🎀 Data Fields 🎀

here's the whole squad, no one left behind:

• int displayNumber
• unsigned int regionBegin
• int regionSize
• const char * text
• int textSize
• const unsigned char * andMask
• const unsigned char * orMask
• int cursor
• const char * charset

---

🦋 Detailed Description 🦋

so basically, this is the structure containing arguments to be given to brlapi_write(). that's it, that's her job, and she does it flawlessly, no cap 💯

---

👑 Field Documentation 👑

🌈 const unsigned char* brlapi_writeArguments_t::andMask

the and attributes, bestie. and they get applied first. order matters, she's got a whole process ✨

🍓 const char* brlapi_writeArguments_t::charset

text charset, okay, listen carefully because this one has lore:

• NULL means it's assumed to be 8bits, and the same as the server's. simple. iconic.
• "" means the current locale's charset 🌍
• if no locale was selected, it defaults to what NULL means. yeah. we go back to NULL's whole thing. it's giving circular but it's correct 💀

💜 int brlapi_writeArguments_t::cursor

where the cursor goes, pick your fighter:

• BRLAPI_CURSOR_LEAVE == don't touch her, leave her alone 🙈
• BRLAPI_CURSOR_OFF == turn her off ✨
• 1 = 1st char of display, and so on, and so forth, you get the pattern 👑

🧚 int brlapi_writeArguments_t::displayNumber

display number, bestie. and BRLAPI_DISPLAY_DEFAULT == unspecified, i.e. "idk, you pick" 🫶

🔥 const unsigned char* brlapi_writeArguments_t::orMask

the or attributes, and these get applied after ANDing. andMask first, orMask after. sequence. choreography. slay 💅

🌸 unsigned int brlapi_writeArguments_t::regionBegin

the region of the display you wanna update, and the numbering is very specific so stay with me:

• 1st character of display is 1 ✨
• 1st character of the second line of display is the width of a line plus 1
• etc., you get it

and regions are always a linear wrap over the different lines. linear wrap. she does not do fancy 2D nonsense, she wraps, periodt 🌈

🎀 int brlapi_writeArguments_t::regionSize

the number of characters held in andMask and orMask 🫶 and here's the plot twist: if it's negative, its absolute value is taken into account, and the output gets padded or truncated to fill the rest of the display. so negative is not an error, it's a choice 💅

⭐ const char* brlapi_writeArguments_t::text

the text to display, bestie. and it must hold as many characters as the region fields express. like, that's the rule. match the count, no notes 📏

💖 int brlapi_writeArguments_t::textSize

size of text in bytes (bytes!! not vibes!!). and if it's -1, then strlen() is used for computing it. easy. automatic. lowkey convenient 🌟

---

💜 Author 💜

Generated automatically by Doxygen for BrlAPI from the source code. she was born in a doc generator and she's thriving 😭💖

---

okay bestie that's the whole page, you ate it, you understood it, main character energy fr fr 🌸✨💅 and for the cute sign-off: this whole thing comes from BrlAPI, Version 0.8, and it's the brlapi_writeArguments_t(3) page 🎀 go write some braille, queen 👑🦋