friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/QOKDSPDP.htm

384 lines
9.7 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Display Directory Panels (QOKDSPDP) API</title>
<!-- Begin Header Records ========================================== -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
<!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited October 2001 -->
<!-- Updates from System API Programming book phase-out, July 2002 by JET -->
<!--End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>Display Directory Panels (QOKDSPDP) API</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">User ID</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">User address</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Title</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Function key processing</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Message to be displayed</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Display Directory Panels (QOKDSPDP) API has the ability to display the
Add Directory Information and Change Directory Information displays. It can run that function interactively
without using an administration interface. This API is for interactive use only.</p>
<br>
<h3>Authorities and Locks</h3>
<p>If you have security administrator (*SECADM) authority, you can change all
the directory information. If you do not have security administrator authority,
then you can only change your own directory information.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>User ID</strong></dt>
<dd>INPUT; CHAR(8)
<p>The user ID to be processed. The ID needs to be in character set 697, code
page 500, and monocase.</p>
</dd>
<dt><strong>User address</strong></dt>
<dd>INPUT; CHAR(8)
<p>The address of the user to be processed. The address needs to be in
character set 697, code page 500, and monocase.</p>
</dd>
<dt><strong>Title</strong></dt>
<dd>INPUT; CHAR(10)
<p>The type of directory panel to be displayed. The following are the possible
values:</p>
<table cellpadding="3">
<!-- cols="10 90" -->
<tr>
<td valign="top"><em>*CHG</em></td>
<td valign="top">Change directory information</td>
</tr>
<tr>
<td valign="top"><em>*ADD</em></td>
<td valign="top">Add directory information</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Function key processing</strong></dt>
<dd>OUTPUT; CHAR(10)
<p>The operation processed for the key pressed. This indicates what type of
ending processing to do. The following are the possible values:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>*ENTER</em></td>
<td valign="top">The enter operation is processed.</td>
</tr>
<tr>
<td valign="top"><em>*F3</em></td>
<td valign="top">The exit operation is processed.</td>
</tr>
<tr>
<td valign="top"><em>*F12</em></td>
<td valign="top">The previous display is shown.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Message to be displayed</strong></dt>
<dd>INPUT; CHAR(*)
<p>A structure with a message ID and replacement text that is to be shown on
the display. If the message size is 0, no message will be displayed. For the
format of the structure, see <a href="#HDRMSGDS">Message to Be Displayed
Format</a>.</p>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
</dd>
</dl>
<br>
<h3><a name="HDRMSGDS">Message to Be Displayed Format</a></h3>
<p>The format of the message to be displayed parameter is as follows:</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(2)</td>
<td align="left" valign="top" width="60%">Message size</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="center" valign="top">2</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Message ID</td>
</tr>
<tr>
<td align="center" valign="top">9</td>
<td align="center" valign="top">9</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Message file</td>
</tr>
<tr>
<td align="center" valign="top">17</td>
<td align="center" valign="top">11</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Message type</td>
</tr>
<tr>
<td align="center" valign="top">21</td>
<td align="center" valign="top">15</td>
<td align="left" valign="top">BINARY(2)</td>
<td align="left" valign="top">Length of message data</td>
</tr>
<tr>
<td align="center" valign="top">23</td>
<td align="center" valign="top">17</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Message data</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<p><strong>Length of message data.</strong> The length of the message data. The
maximum length is 256.</p>
<p><strong>Message data.</strong> The data to be replaced in the message. The
maximum size is 256.</p>
<p><strong>Message file.</strong> The message file name where the message is
displayed from. When the message is sent, it picks up the message library from
*LIBL.</p>
<p><strong>Message ID.</strong> The message ID of the message to be
displayed.</p>
<p><strong>Message size.</strong> The total length of the message to be
displayed format. If this value is greater than zero, the message will be
sent.</p>
<p><strong>Message type.</strong> The message type of the message to be
signaled. The valid values are:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>INFO</em></td>
<td valign="top">Informational</td>
</tr>
<tr>
<td valign="top"><em>DIAG</em></td>
<td valign="top">Diagnostic</td>
</tr>
<tr>
<td valign="top"><em>ESCP</em></td>
<td valign="top">Escape</td>
</tr>
<tr>
<td valign="top"><em>COMP</em></td>
<td valign="top">Completion</td>
</tr>
<tr>
<td valign="top"><em>NTFY</em></td>
<td valign="top">Notify</td>
</tr>
<tr>
<td valign="top"><em>STAT</em></td>
<td valign="top">Status</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRERMSG">Error Messages</a></h3>
<table width="100%" cellpadding="3">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF89A0 E</td>
<td valign="top">Values passed to QOKDSPDP are not valid</td>
</tr>
<tr>
<td align="left" valign="top">CPF9024 E</td>
<td valign="top">System cannot get correct record to finish operation.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9054 E</td>
<td valign="top">Description '&amp;1' already exists.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9083 E</td>
<td valign="top">User ID and address &amp;1 &amp;2 not changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9810 E</td>
<td valign="top">Library &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9830 E</td>
<td valign="top">Cannot assign library &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9845 E</td>
<td valign="top">Error occurred while opening file &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9846 E</td>
<td valign="top">Error while processing file &amp;1 in library &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td valign="top">Program or service program &amp;1 in library &amp;2 ended.
Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V2R2
<hr>
<table cellpadding="2" cellspacing="2" align="center">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"off1a.htm">Office APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink