annotate docs/ccguide/read.refentry @ 573:d9ab3688bb71

All function prototypes are added.
author roug
date Fri, 01 Nov 2002 10:02:34 +0000
parents fcb97f0ba24b
children c49be44efba2
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="read">
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
2 <refnamediv>
468
60b821f18853 A little here and there.
roug
parents: 466
diff changeset
3 <refname>Read</refname>
60b821f18853 A little here and there.
roug
parents: 466
diff changeset
4 <refpurpose>read from a file</refpurpose>
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
5 </refnamediv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
6
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
7 <refsynopsisdiv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
8 <funcsynopsis>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
9 <funcprototype>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
10 <funcdef><function>read</function></funcdef>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
11 <paramdef>type <parameter>arg1</parameter></paramdef>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
12 </funcprototype>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
13 </funcsynopsis>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
14
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
15 </refsynopsisdiv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
16
542
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
17 <refsect1><title>Assembler Equivalent</title>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
18 <para>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
19 os9 I$READ
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
20 </para>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
21 <para>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
22 os9 I$READLN
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
23 </para>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
24 </refsect1>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
25
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
26 <refsect1><title>Description</title>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
27 <para>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
28 Placeholder
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 </refsect1>
542
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
31
552
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
32 <refsect1><title>Diagnostics</title>
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
33 <para>
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
34 Read and readln return the number of bytes actually read (0 at
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
35 end-of-file) or -1 for physical i/o errors, a bad path number,
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
36 or a ridicolous "count".
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
37 </para>
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
38 <para>
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
39 NOTE that end-of-file is not considered an error, and no error
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
40 indication is returned. Zero is returned on EOF.
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
41 </para>
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
42 </refsect1>
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
43
542
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
44 <refsect1><title>See Also</title>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
45 <para>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
46 <link linkend="open">open()</link>,
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
47 <link linkend="creat">creat()</link>,
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
48 <link linkend="dup">dup()</link>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
49 </para>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
50 </refsect1>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
51
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
52 </refentry>