annotate docs/ccguide/gets.refentry @ 570:253b6096ee01

All function prototypes are added.
author roug
date Fri, 01 Nov 2002 10:02:34 +0000
parents fcb97f0ba24b
children a74b8d8c28db
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
1 <refentry id="gets">
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
2 <refnamediv>
570
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
3 <refname>Gets</refname>
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
4 <refname>Fgets</refname>
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
5 <refpurpose>input a string</refpurpose>
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
6 </refnamediv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
7
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
8 <refsynopsisdiv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
9 <funcsynopsis>
468
60b821f18853 A little here and there.
roug
parents: 466
diff changeset
10 <funcsynopsisinfo>
60b821f18853 A little here and there.
roug
parents: 466
diff changeset
11 #include &lt;stdio.h&gt;
60b821f18853 A little here and there.
roug
parents: 466
diff changeset
12 </funcsynopsisinfo>
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
13 <funcprototype>
570
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
14 <funcdef>char *<function>gets</function></funcdef>
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
15 <paramdef>char *<parameter>s</parameter></paramdef>
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
16 </funcprototype>
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
17
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
18 <funcprototype>
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
19 <funcdef>char *<function>fgets</function></funcdef>
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
20 <paramdef>char *<parameter>s</parameter></paramdef>
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
21 <paramdef>int <parameter>n</parameter></paramdef>
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
22 <paramdef>FILE *<parameter>fp</parameter></paramdef>
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
23 </funcprototype>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
24 </funcsynopsis>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
25
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
26 </refsynopsisdiv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
27
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
28 <refsect1><title>Description</title>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
29 <para>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
30 Placeholder
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
31 </para>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
32 </refsect1>
542
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
33
552
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
34 <refsect1><title>Caveats</title>
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
35 <para>
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
36 The different treatment of the "\n" by these functions is
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
37 retained here for portability reasons.
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
38 </para>
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
39 </refsect1>
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
40
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
41 <refsect1><title>Diagnostics</title>
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
42 <para>
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
43 Both functions return NULL on end-of-file or error.
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
44 </para>
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
45 </refsect1>
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
46
542
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
47 <refsect1><title>See Also</title>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
48 <para>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
49 <link linkend="puts">puts()</link>,
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
50 <link linkend="getc">getc()</link>,
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
51 <link linkend="scanf">scanf()</link>,
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
52 <link linkend="fread">fread()</link>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
53 </para>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
54 </refsect1>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
55
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
56 </refentry>