1doc::unibi_dump(3)                 unibilium                doc::unibi_dump(3)
2
3
4

NAME

6       unibi_dump - convert a terminal object to compiled terminfo data
7

SYNOPSIS

9        #include <unibilium.h>
10
11        size_t unibi_dump(const unibi_term *ut, char *p, size_t n);
12

DESCRIPTION

14       This function creates a compiled terminfo entry from ut. The output is
15       written to p, which must have room for at least n bytes.
16
17       If all numeric properties in ut have values that fit in 15 bits, the
18       traditional ncurses terminfo format is used (starting with the bytes
19       "1A 01"), otherwise the newer "wide integer" format (starting with the
20       bytes "1E 02") is used.
21

RETURN VALUE

23       "unibi_dump" returns the number of bytes required to store the terminfo
24       data.  If this exceeds n, nothing is written to p. If the terminal
25       object can't be represented in terminfo format (e.g. because the string
26       table would be too large), the return value is "SIZE_MAX".
27

ERRORS

29       "EINVAL"
30           ut can't be converted to terminfo format.
31
32       "EFAULT"
33           The resulting terminfo entry would be longer than n bytes.
34

SEE ALSO

36       unibilium.h(3), unibi_destroy(3), unibi_from_mem(3)
37
38
39
40unibilium-2.1.1                   2022-07-23                doc::unibi_dump(3)
Impressum