home | help
doc::unibi_dump(3)		    unibilium		      doc::unibi_dump(3)

NAME
     unibi_dump - convert a terminal object to compiled terminfo data

SYNOPSIS
      #include <unibilium.h>

      size_t unibi_dump(const unibi_term *ut, char *p, size_t n);

DESCRIPTION
     This function creates a compiled terminfo entry from ut. The output is
     written to p, which must have room for at least n bytes.

     If all numeric properties in ut have values that fit in 15 bits, the tradi-
     tional ncurses terminfo format is used (starting with the bytes "1A 01"),
     otherwise the newer "wide integer" format (starting with the bytes "1E 02")
     is used.

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

ERRORS
     "EINVAL"
	 ut can't be converted to terminfo format.

     "EFAULT"
	 The resulting terminfo entry would be longer than n bytes.

SEE ALSO
     unibilium.h(3), unibi_destroy(3), unibi_from_mem(3)

unibilium-2.1.2 		   2024-09-13		      doc::unibi_dump(3)

home | help