is the pointer to the buffer where the values extracted from the matching sequence of
.BRctlseqs_read()
will be stored.
.PP
Field
.Imaxlen
specifies the maximum possible length (in bytes) of control sequence to be read.
.PP
Field
.Ifd
is the file descriptor to read from.
.PP
Field
.Iflags
is the bit mask of multiple boolean options.
.SSBufferValues
A
.Ibuffer
is an array of
.BR"union ctlseqs_value",
as shown below:
.PP
.nf
.in+4n
.EX
union ctlseqs_value {
char const *str;
unsigned long num;
};
.EE
.in
.fi
.PP
The value can be either a string (not guaranteed to be NUL-terminated), or an unsigned integer.
Once a sequence is successfully matched, a group of values is extracted from the sequence for each placeholder, and stored into the buffer sequentially.
.PP
A group can contain one or multiple values, depending on different placeholders:
.TP
.BCTLSEQS_PH_NUM
A single unsigned integer.
.TP
.BCTLSEQS_PH_NUMS
An unsigned integer indicating the number of extracted values, followed by unsigned integers of that many.
.TP
.BCTLSEQS_PH_STR
An unsigned integer indicating the number of characters of the extracted string, followed by a string of printable characters.
.TP
.BCTLSEQS_PH_CMDSTR
An unsigned integer indicating the number of characters of the extracted string, followed by a string containing only printable characters and characters of range 0x08\(ti0x0d.
.TP
.BCTLSEQS_PH_CSI_PARAM
An unsigned integer indicating the number of characters of the extracted string, followed by a string of CSI parameter bytes (range 0x30\(ti0x3f).
.TP
.BCTLSEQS_PH_CSI_INTMD
An unsigned integer indicating the number of characters of the extracted string, followed by a string of CSI intermediate bytes (range 0x20\(ti0x2f).
.TP
.BCTLSEQS_PH_HEXNUM
A single unsigned integer, which is the integer value of extracted hexadecimal string.
.TP
.BCTLSEQS_PH_CHRSTR
An unsigned integer indicating the number of characters of the extracted string, followed by a string of any bit combination which does not represent SOS or ST.
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.