ctlseqs/man/ctlseqs_reader_init.3

36 lines
959 B
Groff
Raw Normal View History

2021-11-11 07:24:50 +00:00
.TH CTLSEQS_READER_INIT 3 "Sep 01, 2020" 0.1.0 ctlseqs
2020-11-17 06:24:43 +00:00
.
.SH NAME
ctlseqs_reader_init - initialize control sequence reader
.
.SH SYNOPSYS
.nf
.B #include <ctlseqs.h>
.PP
.B struct ctlseqs_reader *ctlseqs_reader_init(void);
.fi
.
.SH DESCRIPTION
Creates a control sequence reader, which can be configured with
2021-11-11 07:24:50 +00:00
.BR ctlseqs_reader_config .
2020-11-17 06:24:43 +00:00
.PP
2021-11-11 07:24:50 +00:00
Instance of a reader should be freed with
.BR ctlseqs_reader_free .
2020-11-17 06:24:43 +00:00
.
.SH RETURN VALUE
Returns a pointer to opaque type
.B struct ctlseqs_reader
holding the reader instance.
.PP
If the function fails to allocate sufficient memory, returns NULL.
.
.SH COPYRIGHT
2021-11-11 07:24:50 +00:00
Copyright (c) 2020,2021 CismonX <admin@cismon.net>
2020-11-17 06:24:43 +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.
2020-12-10 08:03:18 +00:00
This file is offered as-is, without any warranty.
2020-12-21 12:56:27 +00:00
.
.SH SEE ALSO
.BR ctlseqs_reader_config (3),
.BR ctlseqs_reader_free (3)