File: tickit_term_setctl_int.3

package info (click to toggle)
libtickit 0.4.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,556 kB
  • sloc: ansic: 13,904; perl: 228; makefile: 161; sh: 38
file content (23 lines) | stat: -rw-r--r-- 1,336 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
.TH TICKIT_TERM_SETCTL_INT 3
.SH NAME
tickit_term_setctl_int, tickit_term_setctl_str \- set an integer or string terminal control
.SH SYNOPSIS
.EX
.B #include <tickit.h>
.sp
.BI "bool tickit_term_getctl_int(TickitTerm *" tt ", TickitTermCtl " ctl ", int *" value );
.BI "bool tickit_term_setctl_int(TickitTerm *" tt ", TickitTermCtl " ctl ", int " value );
.BI "bool tickit_term_setctl_str(TickitTerm *" tt ", TickitTermCtl " ctl ", const char *" value );
.EE
.sp
Link with \fI\-ltickit\fP.
.SH DESCRIPTION
\fBtickit_term_setctl_int\fP() performs a terminal control operation, setting the value of a numeric terminal control option. \fBtickit_term_setctl_str\fP() sets the value of a string terminal control option. \fBtickit_term_getctl_int\fP() obtains the value of a terminal control setting.
.PP
For the list of possible \fBTickitTermCtl\fP values and their meanings, see \fBtickit_term\fP(7).
.SH "RETURN VALUE"
\fBtickit_term_getctl_int\fP() returns a true value if it recognised the requested control and managed to return the current value of it; false if not. \fBtickit_term_setctl_int\fP() and \fBtickit_term_setctl_str\fP() return a true value if it recognised the requested control and managed to request the terminal to change it; false if not.
.SH "SEE ALSO"
.BR tickit_term_build (3),
.BR tickit_term (7),
.BR tickit (7)