ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/dspmod.htm

344 lines
13 KiB
HTML
Raw Permalink Normal View History

2024-04-02 14:02:31 +00:00
<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Display Module (DSPMOD)</title>
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body bgcolor="white">
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<a name="DSPMOD.Top_Of_Page"></a>
<h2>Display Module (DSPMOD)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#DSPMOD.PARAMETERS.TABLE">Parameters</a><br>
<a href="#DSPMOD.COMMAND.EXAMPLES">Examples</a><br>
<a href="#DSPMOD.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="DSPMOD"></a>
<p>The Display Module (DSPMOD) command displays information about a module. The display includes information about the compiler, the source from which the module was created, the processing attributes of the module, and the size of the module.
</p>
<p><b>Restrictions:</b>
</p>
<ul>
<li>You must have use (*USE) authority to the module being displayed and execute (*EXECUTE) authority to the library in which the module is stored.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPMOD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="DSPMOD.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#DSPMOD.MODULE"><b>MODULE</b></a></td>
<td valign="top">Module</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Required, Positional 1</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Module</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top"><a href="#DSPMOD.DETAIL"><b>DETAIL</b></a></td>
<td valign="top">Detail</td>
<td valign="top">Single values: <b><u>*ALL</u></b><br>Other values (up to 7 repetitions): *BASIC, *SIZE, *EXPORT, *IMPORT, *PROCLIST, *REFSYSOBJ, *COPYRIGHT</td>
<td valign="top">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#DSPMOD.OUTPUT"><b>OUTPUT</b></a></td>
<td valign="top">Output</td>
<td valign="top"><b><u>*</u></b>, *PRINT, *OUTFILE</td>
<td valign="top">Optional, Positional 3</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#DSPMOD.OUTFILE"><b>OUTFILE</b></a></td>
<td valign="top">File to receive output</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: File to receive output</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top" rowspan="3"><a href="#DSPMOD.OUTMBR"><b>OUTMBR</b></a></td>
<td valign="top">Output member options</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Member to receive output</td>
<td valign="top">
<i>Name</i>, <b><u>*FIRST</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: Replace or add records</td>
<td valign="top">
<b><u>*REPLACE</u></b>, *ADD</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#DSPMOD.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="DSPMOD.MODULE"></a>
<h3>Module (MODULE)</h3>
<p>Specifies the module for which information is to be displayed.
</p>
<p>This is a required parameter.
</p>
<p><b>Qualifier 1: Module</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the module for which information is displayed.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the library list for the current thread are searched until the first match is found.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library to be searched.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPMOD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPMOD.DETAIL"></a>
<h3>Detail (DETAIL)</h3>
<p>Specifies which set of information is displayed for the module.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All the information applicable to the specified module is displayed or printed.
<p>
<b>Note: </b>DETAIL(*ALL) is valid only when information is displayed or printed. It is not valid if *OUTFILE is specified for the <b>Output (OUTPUT)</b> parameter.
</p>
</dd>
</dl>
<p><b>Other values (up to 7 repetitions)</b>
</p>
<dl>
<dt><b>*BASIC</b></dt>
<dd>The basic module information, module compatibility section, and SQL information is shown.
</dd>
<dt><b>*SIZE</b></dt>
<dd>The size and size limits for this module are shown.
</dd>
<dt><b>*EXPORT</b></dt>
<dd>The symbols defined in this module that are exported to other modules are shown.
</dd>
<dt><b>*IMPORT</b></dt>
<dd>The symbols defined externally to this module are shown.
</dd>
<dt><b>*PROCLIST</b></dt>
<dd>A list of the procedure names with their type and priority is shown.
</dd>
<dt><b>*REFSYSOBJ</b></dt>
<dd>A list of the system objects referred to by this module when the module is bound into a bound program or service program is shown.
</dd>
<dt><b>*COPYRIGHT</b></dt>
<dd>Copyright information for this module is shown.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPMOD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPMOD.OUTPUT"></a>
<h3>Output (OUTPUT)</h3>
<p>Specifies whether the output from this command is displayed, printed, or directed to a database file.
</p>
<dl>
<dt><b><u>*</u></b></dt>
<dd>Output requested by an interactive job is shown on the display. Output requested by a batch job is printed with the job's spooled output.
</dd>
<dt><b>*PRINT</b></dt>
<dd>The output is printed with the job's spooled output.
</dd>
<dt><b>*OUTFILE</b></dt>
<dd>The output is directed to the database file specified for the <b>File to receive output (OUTFILE)</b> parameter.
<p>
<b>Note: </b>When a procedure name longer than 256 characters is encountered and the value *OUTFILE is specified, the last 253 characters of the procedure name are placed in the output file and are preceded by three less than (&lt;&lt;&lt;) characters. The less than (&lt;&lt;&lt;) characters indicate that this is only a partial name. The diagnostic message CPD5D12, which indicates that not all available information is returned, is sent to the job log. The same message is sent as a status message to the calling program of the command processing program (CPP) that can be monitored. You can use the Retrieve Module Information (QBNRMODI) or the List Module Information (QBNLMODI) APIs to find the complete name of the procedure.
</p>
<p>
<b>Note: </b>DETAIL(*ALL) is not valid when OUTPUT(*OUTFILE) is specified.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPMOD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPMOD.OUTFILE"></a>
<h3>File to receive output (OUTFILE)</h3>
<p>Specifies the database file to which the output of this command is directed. If the output file does not exist, this command creates a database file in the specified library. If the file is created, the text is "Output file for DSPMOD", The public authority of the file is the same as the create authority specified for the library in which the file is created. The record format of the output file will be the same as that used in the IBM-supplied database file.
</p>
<p>
<b>Note: </b>When a procedure name longer than 256 characters is encountered and the value *OUTFILE is specified, the last 253 characters of the procedure name are placed in the output file and are preceded by three less than (&lt;&lt;&lt;) characters. The less than (&lt;&lt;&lt;) characters indicate that this is only a partial name. The diagnostic message CPD5D12, which indicates that not all available information is returned, is sent to the job log. The same message is sent as a status message to the calling program of the command processing program (CPP) that can be monitored. You can use the Retrieve Module Information (QBNRMODI) or the List Module Information (QBNLMODI) APIs to find the complete name of the procedure.
</p>
<p>The IBM-supplied database files and their record formats are as follows:
</p>
<p>
<pre>
Detail: File: Record Format:
*BASIC QABNDMBA QBNDMBAS
*SIZE QABNDMSI QBNDMSIZ
*EXPORT QABNDMEX QBNDMEXP
*IMPORT QABNDMIM QBNDMIMP
*PROCLIST QABNDMPR QBNDMPRO
*REFSYSOBJ QABNDMRE QBNDMREF
*COPYRIGHT QABNDMCO QBNDMCOP
</pre>
</p>
<p><b>Qualifier 1: File to receive output</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the database file that receives the output of this command.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the library list for the current thread are searched until the first match is found.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library to be searched.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPMOD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPMOD.OUTMBR"></a>
<h3>Output member options (OUTMBR)</h3>
<p>Specifies the name of the database file member to which the output is directed. If a member already exists, the system uses the second element of this parameter to determine whether the member is cleared before the new records are added. If the member does not exist and a member name is not specified, the system creates a member with the name of the output file specified for the <b>File to receive output (OUTFILE)</b> parameter If an output file member name is specified, but the member does not exist, the system creates it.
</p>
<p><b>Element 1: Member to receive output</b>
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The first member in the file receives the output. If OUTMBR(*FIRST) is specified and a file member does not exist, the system creates a member with the name of the file specified on the OUTFILE parameter.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the file member that receives the output. If the member does not exist, the system creates it.
</dd>
</dl>
<p><b>Element 2: Replace or add records</b>
</p>
<dl>
<dt><b><u>*REPLACE</u></b></dt>
<dd>The system clears the existing member and adds the new records.
</dd>
<dt><b>*ADD</b></dt>
<dd>The system adds the new records to the end of the existing records.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPMOD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPMOD.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
DSPMOD MODULE(MYMOD)
</pre>
</p>
<p>This command displays module object MYMOD from the library list.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPMOD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPMOD.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF5CE7</b></dt>
<dd>Error occurred while retrieving *MODULE data
</dd>
<dt><b>CPF9801</b></dt>
<dd>Object &amp;2 in library &amp;3 not found.
</dd>
<dt><b>CPF9802</b></dt>
<dd>Not authorized to object &amp;2 in &amp;3.
</dd>
<dt><b>CPF9803</b></dt>
<dd>Cannot allocate object &amp;2 in library &amp;3.
</dd>
<dt><b>CPF9807</b></dt>
<dd>One or more libraries in library list deleted.
</dd>
<dt><b>CPF9808</b></dt>
<dd>Cannot allocate one or more libraries on library list.
</dd>
<dt><b>CPF9810</b></dt>
<dd>Library &amp;1 not found.
</dd>
<dt><b>CPF9820</b></dt>
<dd>Not authorized to use library &amp;1.
</dd>
<dt><b>CPF9830</b></dt>
<dd>Cannot assign library &amp;1.
</dd>
<dt><b>CPF9871</b></dt>
<dd>Error occurred while processing.
</dd>
</dl>
<p><b><u>*STATUS Messages</u></b>
</p>
<dl>
<dt><b>CPD5D12</b></dt>
<dd>One or more records have incomplete values.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPMOD.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>