2021-11-11 07:24:50 +00:00
.TH CTLSEQS_PURGE 3 "Sep 01, 2020" 0 .1.0 ctlseqs
2020-12-10 09:27:34 +00:00
.
.SH NAME
ctlseqs_purge - purge read buffer
.
.SH SYNOPSYS
.nf
.B #include <ctlseqs.h>
.PP
2021-11-11 07:24:50 +00:00
.B void ctlseqs_purge(
.BI " struct ctlseqs_reader *" reader ,
.BI " size_t " nbytes
.B );
2020-12-10 09:27:34 +00:00
.fi
.
.SH DESCRIPTION
Removes up to
.I nbytes
number of leading bytes from the internal read buffer of given
.IR reader ,
and resets the current state of the reader.
.PP
If
.I nbytes
is zero, this function has no effect.
.
.SH RETURN VALUE
This function has no return values.
.
.SH NOTES
2020-12-14 13:12:09 +00:00
The function is useful when dealing with partial sequences returned by
2021-11-11 07:24:50 +00:00
.BR ctlseqs_read ,
2020-12-10 09:27:34 +00:00
whose future completion is not desired.
.
.SH COPYRIGHT
2021-02-26 09:43:53 +00:00
Copyright (c) 2020,2021 CismonX <admin@cismon.net>
2020-12-10 09:27:34 +00:00
.PP
Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved.
This file is offered as-is, without any warranty.
2020-12-21 12:56:27 +00:00
.
.SH SEE ALSO
2021-02-26 09:43:53 +00:00
.BR ctlseqs_read (3)
