annotate docs/ccguide/modload.refentry @ 2112:cfb3a637a000

Fixed lack of H6309 flag
author boisy
date Tue, 21 Aug 2007 17:05:14 +0000
parents 42b2c775f05f
children
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="modload">
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>Modload</refname>
60b821f18853 A little here and there.
roug
parents: 466
diff changeset
4 <refpurpose>return a pointer to a module structure</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>
468
60b821f18853 A little here and there.
roug
parents: 466
diff changeset
9 <funcsynopsisinfo>
60b821f18853 A little here and there.
roug
parents: 466
diff changeset
10 #include &lt;module.h&gt;
60b821f18853 A little here and there.
roug
parents: 466
diff changeset
11 </funcsynopsisinfo>
570
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
12
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>mod_exec *<function>modlink</function></funcdef>
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
15 <paramdef>char *<parameter>modname</parameter></paramdef>
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
16 <paramdef>int <parameter>type</parameter></paramdef>
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
17 <paramdef>int <parameter>language</parameter></paramdef>
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
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
20 <funcprototype>
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
21 <funcdef>mod_exec *<function>modload</function></funcdef>
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
22 <paramdef>char *<parameter>modname</parameter></paramdef>
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
23 <paramdef>int <parameter>type</parameter></paramdef>
253b6096ee01 All function prototypes are added.
roug
parents: 552
diff changeset
24 <paramdef>int <parameter>language</parameter></paramdef>
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
25 </funcprototype>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
26 </funcsynopsis>
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 </refsynopsisdiv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
29
542
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
30 <refsect1><title>Assembler Equivalent</title>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
31 <para>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
32 os9 F$LINK
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
33 </para>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
34 <para>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
35 os9 F$LOAD
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
36 </para>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
37 </refsect1>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
38
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
39 <refsect1><title>Description</title>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
40 <para>
602
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
41 Each of these calls return a pointer to an OS-9 memory module.
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
42 </para>
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
43 <para>
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
44 Modlink will search the module directory for a module with the
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
45 same name as "modname" and, if found, increment its link count.
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
46 </para>
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
47 <para>
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
48 Modload will open the file which has the path list specified by
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
49 "filename" and loads modules from the file adding them to the
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
50 module directory. The returned value is a pointer to the first
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
51 module loaded.
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
52 </para>
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
53 <para>
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
54 Above, each is shown as returning a pointer to an executable
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
55 module, but it will return a pointer to whatever type of module
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
56 is found.
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
57 </para>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
58 </refsect1>
542
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
59
552
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
60 <refsect1><title>Diagnostics</title>
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
61 <para>
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
62 -1 is returned on error.
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
63 </para>
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
64 </refsect1>
fcb97f0ba24b All diagnostics added.
roug
parents: 542
diff changeset
65
542
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
66 <refsect1><title>See Also</title>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
67 <para>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
68 <link linkend="munlink">munlink()</link>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
69 </para>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
70 </refsect1>
73319ee6a57e All "See Also" implemented
roug
parents: 468
diff changeset
71
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
72 </refentry>