---
name: "brlapi_writeArguments_t"
section: "3"
platform: "linux"
package: "libbrlapi-dev"
version: "6.7-3.1+deb13u3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/brlapi_writeArguments_t"
---

# brlapi\_writeArguments\_t(3)

## NAME

brlapi\_writeArguments\_t

## SYNOPSIS

`#include <brlapi.h>`

### Data Fields

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

Structure containing arguments to be given to **brlapi\_write()**

## Field Documentation

### const unsigned char\* brlapi\_writeArguments\_t::andMask

And attributes; applied first

### const char\* brlapi\_writeArguments\_t::charset

Text charset. NULL means it is assumed to be 8bits, and the same as the server's. '' means current locale's charset. If no locale was selected, defaults to NULL's meaning.

### int brlapi\_writeArguments\_t::cursor

**BRLAPI\_CURSOR\_LEAVE** == don't touch, **BRLAPI\_CURSOR\_OFF** == turn off, 1 = 1st char of display, ...

### int brlapi\_writeArguments\_t::displayNumber

Display number **BRLAPI\_DISPLAY\_DEFAULT** == unspecified

### const unsigned char\* brlapi\_writeArguments\_t::orMask

Or attributes; applied *after* ANDing

### unsigned int brlapi\_writeArguments\_t::regionBegin

Region of display to update, 1st character of display is 1, 1st character of the second line of display is the width of a line plus 1, etc. Regions are always a linear wrap over the different lines.

### int brlapi\_writeArguments\_t::regionSize

Number of characters held in andMask and orMask. If negative, its absolute value is taken into account, and the output is padded or truncated to fill the rest of the display.

### const char\* brlapi\_writeArguments\_t::text

Text to display, must hold as many characters as the region fields expresses.

### int brlapi\_writeArguments\_t::textSize

Size of text in bytes. If -1, strlen() is used for computing it.

## Author

Generated automatically by Doxygen for BrlAPI from the source code.
