.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "doc::unibi_add_ext_num 3" .TH doc::unibi_add_ext_num 3 2024-03-20 unibilium-2.1.1 unibilium .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME unibi_add_ext_bool, unibi_add_ext_num, unibi_add_ext_str \- add extended capabilities to a terminal object .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include \& \& size_t unibi_add_ext_bool(unibi_term *ut, const char *t, int b); \& size_t unibi_add_ext_num(unibi_term *ut, const char *t, int v); \& size_t unibi_add_ext_str(unibi_term *ut, const char *t, const char *s); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" Add an extended boolean, numeric, or string capability with the specified name and value. .PP Note that these functions simply store any pointers they are given. They will not free \fIt\fR or \fIs\fR or copy any strings. .SH "RETURN VALUE" .IX Header "RETURN VALUE" The return value is the index of the new capability, which can be used in \&\fBunibi_get_ext_bool\fR\|(3), \fBunibi_set_ext_bool\fR\|(3), etc. If an error occurs, \&\f(CW\*(C`SIZE_MAX\*(C'\fR is returned. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBunibilium.h\fR\|(3), \&\fBunibi_del_ext_bool\fR\|(3), \&\fBunibi_del_ext_num\fR\|(3), \&\fBunibi_del_ext_str\fR\|(3)