Adding documentation and some minor reformatting to ensure consistency
This commit is contained in:
@@ -289,6 +289,7 @@ function.
|
||||
<item><ref id="cclear" name="cclear">
|
||||
<item><ref id="cclearxy" name="cclearxy">
|
||||
<item><ref id="cgetc" name="cgetc">
|
||||
<item><ref id="cgets" name="cgets">
|
||||
<item><ref id="chline" name="chline">
|
||||
<item><ref id="chlinexy" name="chlinexy">
|
||||
<item><ref id="clrscr" name="clrscr">
|
||||
@@ -2715,6 +2716,44 @@ see anything that you type. (See the description of <tt/cbm_k_scnkey()/.)
|
||||
</quote>
|
||||
|
||||
|
||||
<sect1>cgets<label id="cgets"><p>
|
||||
|
||||
<quote>
|
||||
<descrip>
|
||||
<tag/Function/Input a string directly to the console.
|
||||
<tag/Header/<tt/<ref id="conio.h" name="conio.h">/
|
||||
<tag/Declaration/<tt/char* __fastcall__ cgets (const char* buffer, int size);/
|
||||
<tag/Description/The function inputs a string of at most <tt/size - 1/
|
||||
characters from the console into <tt/buffer/. It returns when <tt/size - 1/
|
||||
characters or either <tt/CR/ or <tt/LF/ are entered. It also handles both
|
||||
multi-line input and backspacing.
|
||||
<tag/Notes/<itemize>
|
||||
<item>The function echoes <tt/CRLF/ when either <tt/CR/ or <tt/LF/ are read
|
||||
but does NOT append either in <tt/buffer/.
|
||||
<item>The function is only available as fastcall function, so it may only
|
||||
be used in the presence of a prototype.
|
||||
</itemize>
|
||||
<tag/Availability/cc65
|
||||
<tag/See also/
|
||||
<ref id="cgetc" name="cgetc">
|
||||
<tag/Example/<verb>
|
||||
#include <conio.h>
|
||||
|
||||
int main ()
|
||||
{
|
||||
char buffer[200], *p;
|
||||
|
||||
cputs ("Type a lot and backspace a lot: ");
|
||||
if (p = cgets (buffer, sizeof(buffer)))
|
||||
cputs (p);
|
||||
|
||||
return 0;
|
||||
}
|
||||
</verb>
|
||||
</descrip>
|
||||
</quote>
|
||||
|
||||
|
||||
<sect1>chline<label id="chline"><p>
|
||||
|
||||
<quote>
|
||||
|
||||
@@ -110,7 +110,7 @@ char cgetc (void);
|
||||
** 1 (see below), a blinking cursor is displayed while waiting.
|
||||
*/
|
||||
|
||||
char* __fastcall__ cgets (char *buffer, int size);
|
||||
char* __fastcall__ cgets (char* buffer, int size);
|
||||
/* Get a string of characters directly from the console. The function returns
|
||||
** when size - 1 characters or either CR/LF are read. Note the parameters are
|
||||
** more aligned with stdio fgets() as opposed to the quirky "standard" conio
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
** Modified: <iso-date> <author>
|
||||
** Notes: <e.g. revisions made to support target, edge cases, bugs, etc.>
|
||||
**
|
||||
** char* __fastcall__ cgets (char *buffer, int size);
|
||||
** char* __fastcall__ cgets (char* buffer, int size);
|
||||
*/
|
||||
|
||||
#include <stddef.h>
|
||||
@@ -14,7 +14,7 @@
|
||||
#define CRLF "\r\n"
|
||||
#endif /* CRLF */
|
||||
|
||||
char* __fastcall__ cgets (char *buffer, int size)
|
||||
char* __fastcall__ cgets (char* buffer, int size)
|
||||
/* Get a string of characters directly from the console. The function returns
|
||||
** when size - 1 characters or either CR/LF are read. Note the parameters are
|
||||
** more aligned with stdio fgets() as opposed to the quirky "standard" conio
|
||||
|
||||
Reference in New Issue
Block a user