brlapi_info(3)

💖 brlapi_info 💖 — NAME

brlapi_info — getting Terminal information, bestie 💅

• how to get info about the connected Terminal, fr fr

okay so this whole page lives in the Library Functions Manual, and it's literally just the group chat for everything you need to know about asking your braille terminal "who are you bestie? 👀"

---

✨ SYNOPSIS ✨

🎀 Macros

#define BRLAPI_MAXNAMELENGTH   31

🦋 Functions

int BRLAPI_STDCALL brlapi_getDriverName (char *buffer, size_t size)
int BRLAPI_STDCALL brlapi__getDriverName (brlapi_handle_t *handle, char
    *buffer, size_t size)
int BRLAPI_STDCALL brlapi_getModelIdentifier (char *buffer, size_t size)
int BRLAPI_STDCALL brlapi__getModelIdentifier (brlapi_handle_t *handle,
    char *buffer, size_t size)
int BRLAPI_STDCALL brlapi_getDisplaySize (unsigned int *x, unsigned int
    *y)
int BRLAPI_STDCALL brlapi__getDisplaySize (brlapi_handle_t *handle,
    unsigned int *x, unsigned int *y)

---

🌸 Detailed Description 🌸

okay so before you go touching Raw mode or key codes, the application should always check the type of the connected terminal, so you're sure it's really the one you expect. no cap. vibe check first, always 🫶

and you should also check the display size, so you can adjust further displaying on it. it's giving "measure twice, slay once" 💅

---

🎀 Macro Definition Documentation 🎀

#define BRLAPI_MAXNAMELENGTH 31

maximum name length for driver names embeded in BrlAPI packets, and it does not count any termination \0 character. so like, the null byte is on its own little journey, iconic honestly ⭐

---

💅 Function Documentation 💅

int BRLAPI_STDCALL brlapi__getDisplaySize (brlapi_handle_t * handle, unsigned int * x, unsigned int * y)

references BRLAPI_STDCALL. that's the whole entry, she's lowkey mysterious 🙈

int BRLAPI_STDCALL brlapi__getDriverName (brlapi_handle_t * handle, char * buffer, size_t size)

references BRLAPI_STDCALL. short and sweet, we stan ✨

int BRLAPI_STDCALL brlapi__getModelIdentifier (brlapi_handle_t * handle, char * buffer, size_t size)

references BRLAPI_STDCALL. periodt 💜

int BRLAPI_STDCALL brlapi_getDisplaySize (unsigned int * x, unsigned int * y)

return the size of the braille display 👑

references BRLAPI_STDCALL.

int BRLAPI_STDCALL brlapi_getDriverName (char * buffer, size_t size)

return the complete name of the driver used by brltty 🔥

this function fills its argument with the whole name of the braille driver if available, terminated with a '\0'. yes bestie, it's null-terminated, we love to see it.

Parameters

• buffer is the buffer provided by the application;
• size is the maximum size for the name buffer.

Returns

-1 on error, otherwise a positive value giving the size of the needed buffer (including '\0'). and if that value is bigger than size, the value was truncated and the caller should retry with a bigger buffer accordingly. 😭 not the truncation

references BRLAPI_STDCALL.

int BRLAPI_STDCALL brlapi_getModelIdentifier (char * buffer, size_t size)

return an identifier for the device model used by brltty 🦋

this function fills its argument with the whole identifier of the braille device model if available, terminated with a '\0'. same energy, different info, iykyk.

Parameters

• buffer is the buffer given by the application;
• size is the maximum size for the identifier buffer.

Returns

-1 on error, otherwise a positive value giving the size of the needed buffer (including '\0'). if that value is bigger than size, the value was truncated and the caller should retry with a bigger buffer accordingly. 💀 same plot twist

references BRLAPI_STDCALL.

---

🌈 Author 🌈

generated automatically by Doxygen for BrlAPI from the source code. so nobody hand-wrote this and honestly? she still ate 💅✨

---

BrlAPI, Version 0.8, brlapi_info(3) — mwah, that's the whole page bestie, go forth and get your terminal info 🎀🦋💖