p
/
termo
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
termo/man/termkey_get_buffer_remaining.3

24 lines
770 B
Groff
Raw Normal View History

Provide new API function to determine how much buffer space remains in the instance
2012-01-18 11:04:15 +01:00
.TH TERMKEY_GET_BUFFER_REMAINING 3
.SH NAME
termkey_get_buffer_remaining \- returns the free buffer space
.SH SYNOPSIS
.nf
.B #include <termkey.h>
.sp
.BI "size_t termkey_get_buffer_remaining(TermKey *" tk ");
.fi
.sp
Link with \fI-ltermkey\fP.
.SH DESCRIPTION
Link to termkey(7) from other manpages, delete some of the duplicated sections
2012-01-21 01:52:13 +01:00
\fBtermkey_get_buffer_remaining\fP() returns the number of bytes of buffer space currently free in the \fBtermkey\fP(7) instance. These bytes are free to use by \fBtermkey_push_bytes\fP(3), or may be filled by \fBtermkey_advisereadable\fP(3).
Provide new API function to determine how much buffer space remains in the instance
2012-01-18 11:04:15 +01:00
.PP
.SH "RETURN VALUE"
\fBtermkey_get_buffer_remaining\fP() returns a size in bytes.
.SH "SEE ALSO"
Added termkey_push_bytes(), a new API for providing input bytes
2012-01-18 14:39:50 +01:00
.BR termkey_push_bytes (3),
Provide new API function to determine how much buffer space remains in the instance
2012-01-18 11:04:15 +01:00
.BR termkey_advisereadable (3),
Added manpage for termkey_{get,set}_buffer_size
2012-02-14 00:56:59 +01:00
.BR termkey_set_buffer_size (3),
.BR termkey_get_buffer_size (3),
Link to termkey(7) from other manpages, delete some of the duplicated sections
2012-01-21 01:52:13 +01:00
.BR termkey_getkey (3),
.BR termkey (7)