User`s guide

BDOS FUNCTION 10: READ CONSOLE BUFFER
Entry Parameters:
Registers C: 0AH
DE: Buffer Address
Returned Value:
Console Characters in Buffer
The Read Console Buffer function reads a line of edited console input from the
logical console, CONIN:, to a buffer that register pair DE addresses. It terminates
input and returns to the calling program when it encounters a return, CTRL-M, or a
line feed, CTRL-J, character. Function 10 also discards all input characters after the
input buffer is filled. In addition, it outputs a bell character, CTRL-G, to the console
when it discards a character to signal the user that the buffer is full. The input buffer
addressed by DE has the following format:
### Scan and insert illustration here.
where mx is the maximum number of characters which the buffer holds, and nc is
the number of characters placed in the buffer. The characters entered by the operator
follow the nc value. The value mx must be set prior to making a Function 10 call
and may range in value from 1 to 2SS. Setting mx to zero is equivalent to setting mx
to one. The value nc is returned to the calling program and may range from zero to
mx. If nc < mx, then uninitialized positions follow the last character, denoted by ??
in the figure. Note that a terminating return or line feed character is not placed in
the buffer and not included in the count nc.
If register pair DE is set to zero, Function 10 assumes that an initialized input
buffer is located at the current DMA address (see Function 26, Set DMA Address).
This allows a program to put a string on the screen for the user to edit. To initialize
the input buffer, set characters cl through cn to the initial value followed by a binary
zero terminator.
3-12
BDOS Function Calls CP/M 3 Programmers Guide