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

419 lines
14 KiB
HTML

<!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 Data Dictionary (DSPDTADCT)</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="DSPDTADCT.Top_Of_Page"></a>
<h2>Display Data Dictionary (DSPDTADCT)</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="#DSPDTADCT.PARAMETERS.TABLE">Parameters</a><br>
<a href="#DSPDTADCT.COMMAND.EXAMPLES">Examples</a><br>
<a href="#DSPDTADCT.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="DSPDTADCT"></a>
<p>The Display Data Dictionary (DSPDTADCT) command allows the user to display or print the contents of a field definition, record format definition, or file definition in a data dictionary.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDTADCT.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="DSPDTADCT.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"><a href="#DSPDTADCT.DTADCT"><b>DTADCT</b></a></td>
<td valign="top">Data dictionary</td>
<td valign="top"><i>Name</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#DSPDTADCT.DFN"><b>DFN</b></a></td>
<td valign="top">Definition</td>
<td valign="top"><i>Generic name, name</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#DSPDTADCT.DFNTYPE"><b>DFNTYPE</b></a></td>
<td valign="top">Definition type</td>
<td valign="top"><b><u>*FILE</u></b>, *RCDFMT, *FLD</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#DSPDTADCT.OUTPUT"><b>OUTPUT</b></a></td>
<td valign="top">Output</td>
<td valign="top"><b><u>*</u></b>, *PRINT</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#DSPDTADCT.FILEINF"><b>FILEINF</b></a></td>
<td valign="top">File information</td>
<td valign="top"><b><u>*BASIC</u></b>, *DETAIL, *EXTENDED, *ALL, *NONE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#DSPDTADCT.RCDFMTINF"><b>RCDFMTINF</b></a></td>
<td valign="top">Record format information</td>
<td valign="top"><b><u>*BASIC</u></b>, *EXTENDED, *ALL, *NONE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#DSPDTADCT.FLDINF"><b>FLDINF</b></a></td>
<td valign="top">Field information</td>
<td valign="top"><b><u>*BASIC</u></b>, *DETAIL, *EXTENDED, *ALL, *NONE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#DSPDTADCT.CRTDATE"><b>CRTDATE</b></a></td>
<td valign="top">Creation date</td>
<td valign="top"><i>Date</i>, <b><u>*FIRST</u></b></td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#DSPDTADCT.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="DSPDTADCT.DTADCT"></a>
<h3>Data dictionary (DTADCT)</h3>
<p>Specifies the name of the data dictionary that contains the definition being displayed or printed.
</p>
<p>This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDTADCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDTADCT.DFN"></a>
<h3>Definition (DFN)</h3>
<p>Specifies the name of the definition that is displayed or printed.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All definitions of the type specified in the <b>Definition type</b> prompt (DFNTYPE parameter) are displayed or printed.
</dd>
<dt><b><i>definition-name</i></b></dt>
<dd>Specify the name of the definition that is displayed or printed.
</dd>
<dt><b><i>generic*-definition-name</i></b></dt>
<dd>Specify the generic name of the definition that is displayed or printed. A generic name is specified as a character string that contains one or more characters followed by an asterisk (*). If a generic object name is specified, then all definitions that have names with the same prefix as the generic name are displayed or printed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDTADCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDTADCT.DFNTYPE"></a>
<h3>Definition type (DFNTYPE)</h3>
<p>Specifies the type of definitions that are displayed or printed.
</p>
<dl>
<dt><b><u>*FILE</u></b></dt>
<dd>The file definitions are displayed or printed. This value is not valid if *NONE is specified for the <b>File information</b> prompt (FILEINF parameter).
</dd>
<dt><b>*FLD</b></dt>
<dd>The field definitions are displayed or printed. This value is not valid if *NONE is specified for the <b>Field information</b> prompt (FLDINF parameter).
</dd>
<dt><b>*RCDFMT</b></dt>
<dd>The record format definitions are displayed or printed. This value is not valid if *NONE is specified for the <b>Record format information</b> prompt (RCDFMTINF parameter).
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDTADCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDTADCT.OUTPUT"></a>
<h3>Output (OUTPUT)</h3>
<p>Specifies whether the output from the command is displayed at the requesting work station or printed with the job's spooled output.
</p>
<dl>
<dt><b><u>*</u></b></dt>
<dd>The output is displayed for interactive jobs or printed with the job's spooled output for non-interactive jobs.
</dd>
</dl>
<dl>
<dt><b>*PRINT</b></dt>
<dd>The output is printed with the job's spooled output.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDTADCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDTADCT.FILEINF"></a>
<h3>File information (FILEINF)</h3>
<p>Specifies the level of detail that is displayed or printed for the file definition information.
</p>
<dl>
<dt><b><u>*BASIC</u></b></dt>
<dd>The following basic information is displayed or printed:
<ul>
<li>the definition name
</li>
<li>the definition type
</li>
<li>the dictionary in which the definition is located
</li>
<li>the date the definition was created
</li>
<li>the user ID of the person who created it
</li>
<li>the date it was last changed
</li>
<li>the user ID of the person who made the last change
</li>
<li>the text of the definition
</li>
<li>the number of record format definitions used by this file definition
</li>
</ul>
</dd>
<dt><b>*DETAIL</b></dt>
<dd>The basic information, as well as any key field information, is displayed or printed.
</dd>
<dt><b>*EXTENDED</b></dt>
<dd>The detailed information, and any long comment about the file definition, is displayed or printed.
</dd>
<dt><b>*ALL</b></dt>
<dd>The extended information, and a list of files that use this definition, is displayed or printed.
</dd>
<dt><b>*NONE</b></dt>
<dd>No detailed information is printed or displayed about the file definition if *RCDFMT or *FLD is specified for the <b>Definition type</b> prompt (DFNTYPE parameter).
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDTADCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDTADCT.RCDFMTINF"></a>
<h3>Record format information (RCDFMTINF)</h3>
<p>Specifies the level of detail that is printed or displayed for the contents of the record format information.
</p>
<dl>
<dt><b><u>*BASIC</u></b></dt>
<dd>The following basic information is displayed or printed:
<ul>
<li>the definition name
</li>
<li>the definition type
</li>
<li>the dictionary in which the definition is located
</li>
<li>the date the definition was created
</li>
<li>the user ID of the person who created it
</li>
<li>the date it was last changed
</li>
<li>the user ID of the person who made the last change
</li>
<li>the text of the definition
</li>
<li>the number of field definitions used by this record format definition
</li>
<li>the length of the format
</li>
</ul>
</dd>
<dt><b>*EXTENDED</b></dt>
<dd>The basic information, and any long comment about the record format definition, is displayed or printed.
</dd>
<dt><b>*ALL</b></dt>
<dd>The extended information, any record ID codes, and a list of file definitions and files that use this record format definition are displayed or printed.
</dd>
<dt><b>*NONE</b></dt>
<dd>If *NONE is specified, no detailed information is printed or displayed about the record format definitions in a file definition if *FILE is specified for the <b>Definition type</b> prompt (DFNTYPE parameter). *NONE is not valid if *RCDFMT is specified for the <b>Definition type</b> prompt (DFNTYPE parameter). No information can be printed or displayed about a record format definition if *FLD is specified for the <b>Definition type</b> prompt (DFNTYPE parameter).
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDTADCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDTADCT.FLDINF"></a>
<h3>Field information (FLDINF)</h3>
<p>Specifies the level of detail that is printed or displayed for the field description.
</p>
<dl>
<dt><b>*BASIC</b></dt>
<dd>The following basic information is displayed or printed:
<ul>
<li>the definition name
</li>
<li>the definition type
</li>
<li>the dictionary in which the definition is located
</li>
<li>the definition's text
</li>
<li>the data type
</li>
<li>the field length
</li>
<li>the buffer length
</li>
<li>the buffer position
</li>
<li>the field usage
</li>
<li>the column headings
</li>
</ul>
</dd>
<dt><b>*DETAIL</b></dt>
<dd>The basic information is displayed or printed as well as:
<ul>
<li>the date the definition was created
</li>
<li>the user ID of the person who created it
</li>
<li>the date it was last changed
</li>
<li>the user ID of the person who made the last change
</li>
<li>the alias name
</li>
<li>editing information
</li>
</ul>
</dd>
<dt><b><u>*EXTENDED</u></b></dt>
<dd>The detailed information, and any long comment about the field definition, is displayed.
</dd>
<dt><b><u>*ALL</u></b></dt>
<dd>All extended information, and a list of definitions and files that use this definition, is displayed or printed.
</dd>
<dt><b>*NONE</b></dt>
<dd>No detailed information is printed or displayed about the field definition in a record format definition if *FILE or *RCDFMT is specified for the <b>Definition type</b> prompt (DFNTYPE parameter). *NONE is not valid if *FLD is specified for the <b>Definition type</b> prompt (DFNTYPE parameter).
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDTADCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDTADCT.CRTDATE"></a>
<h3>Creation date (CRTDATE)</h3>
<p>Specifies the date on which the definition was created.
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The first definition created with this name is displayed or printed. If multiple definitions with the same name are created on the same date and that name is specified on the <b>Definition</b> prompt (DFN parameter), only the first definition for that date is displayed or printed. If a generic name or *ALL is specified, the <b>Creation date</b> prompt (CRTDATE parameter) is ignored and all definitions matching the <b>Definition</b> prompt (DFN parameter) are displayed or printed.
</dd>
<dt><b><i>date</i></b></dt>
<dd>Specify the creation date of the file definition that is displayed or printed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDTADCT.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPDTADCT.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
DSPDTADCT DTADCT(MINE) DFN(*ALL) DFNTYPE(*FILE)
OUTPUT(*PRINT) FILEINF(*BASIC) RCDFMTINF(*BASIC)
FLDINF(*EXTENDED)
</pre>
</p>
<p>This command prints all file definitions in the data dictionary MINE. Basic information for the file definitions is printed. Basic information for the format definitions in each file definition, and the extended information for the field definitions in each RECORD format definition in the file definitions are printed.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDTADCT.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPDTADCT.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF2DAA</b></dt>
<dd>Printer device &amp;1 not found.
</dd>
<dt><b>CPF2DAC</b></dt>
<dd>Not authorized to use printer device &amp;4.
</dd>
<dt><b>CPF2DAD</b></dt>
<dd>Printer device &amp;4 not currently available.
</dd>
<dt><b>CPF2D76</b></dt>
<dd>Name cannot contain an embedded *.
</dd>
<dt><b>CPF2E9B</b></dt>
<dd>Definition &amp;1 not found.
</dd>
<dt><b>CPF2F02</b></dt>
<dd>Not authorized to use dictionary &amp;1.
</dd>
<dt><b>CPF2F08</b></dt>
<dd>Dictionary &amp;1 not found.
</dd>
<dt><b>CPF3012</b></dt>
<dd>File &amp;1 in library &amp;2 not found.
</dd>
<dt><b>CPF3014</b></dt>
<dd>No file specified as &amp;1 in &amp;2 can be displayed.
</dd>
<dt><b>CPF3024</b></dt>
<dd>File &amp;1 not allowed for SYSTEM(&amp;3).
</dd>
<dt><b>CPF3064</b></dt>
<dd>Library &amp;1 not found.
</dd>
<dt><b>CPF3067</b></dt>
<dd>Error while opening file &amp;1 in &amp;2.
</dd>
<dt><b>CPF3068</b></dt>
<dd>Error while writing to file &amp;1 in &amp;2.
</dd>
<dt><b>CPF3069</b></dt>
<dd>Error while closing file &amp;1 in &amp;2.
</dd>
<dt><b>CPF3074</b></dt>
<dd>Not authorized to library &amp;1.
</dd>
<dt><b>CPF3076</b></dt>
<dd>Error occurred when on display.
</dd>
<dt><b>CPF3077</b></dt>
<dd>Error occurred when canceling display.
</dd>
<dt><b>CPF4253</b></dt>
<dd>Not authorized to output queue for device &amp;6.
</dd>
<dt><b>CPF9850</b></dt>
<dd>Override of printer file &amp;1 not allowed.
</dd>
<dt><b>CPF9851</b></dt>
<dd>Overflow value for file &amp;1 in &amp;2 too small.
</dd>
<dt><b>CPF9852</b></dt>
<dd>Page size too narrow for file &amp;1 in &amp;2.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDTADCT.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>