246 lines
8.4 KiB
HTML
246 lines
8.4 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">
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
|
<title>Directory Search Exit Program</title>
|
|
<!-- 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. -->
|
|
<!-- Begin Header Records ========================================== -->
|
|
<!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
|
|
<!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 -->
|
|
<!--File Edited October 2001 -->
|
|
<!--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>Directory Search Exit Program</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<br>
|
|
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%">Function being requested</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Maximum entries for addressees</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Maximum entries for copy list</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Number of array elements</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">Array</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">Maximum entries for blind copy list</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
<pre>
|
|
QSYSINC Member Name: EOKDRSH1
|
|
</pre>
|
|
</div>
|
|
|
|
<p>The Directory Search exit program allows the administrator to define a customized search of
|
|
directory data. The exit will perform one of three functions: display, select, or optional select. In
|
|
this way, a user-customized search is provided and this search is integrated with OfficeVision programs
|
|
and the system distribution directory.</p>
|
|
|
|
<p>Use the Change System Directory Attributes (CHGSYSDIRA) command to specify the Directory Search exit
|
|
program name in the SCHPGM parameter. When F10 is pressed on the Search System Directory display, the
|
|
Directory Search exit program is called.</p>
|
|
|
|
<br>
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<!-- Use this if there are no authorities and locks. -->
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Function being requested</strong></dt>
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The type of search operation that was requested.</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>*DISPLAY</em></td>
|
|
<td valign="top">Search and display directory information.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>*SELECT</em></td>
|
|
<td valign="top">Search and select user IDs. The output includes user IDs and addresses selected as a result of a search function.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>*OPTSELECT</em></td>
|
|
<td valign="top">Search and select user IDs for addressees and copy list.</td>
|
|
</tr>
|
|
</table>
|
|
<br></dd>
|
|
|
|
<dt><strong>Maximum entries for addressees</strong></dt>
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The maximum number of entries that can be selected for the addressees of the distribution. The maximum number allowable is 100.</p>
|
|
|
|
<p>This parameter is used with the *SELECT and *OPTSELECT values of the function being requested parameter. If the function is *DISPLAY, this value is 0 indicating no output is returned.</p></dd>
|
|
|
|
<dt><strong>Maximum entries for copy list</strong></dt>
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The maximum number of entries that can be selected to be copied on the distribution. This is the maximum number of entries that can be returned in the array parameter with the value of 2 in select option used field. The maximum number allowable is 100.</p>
|
|
|
|
<p>This value is used with the *OPTSELECT value of the function being requested parameter. If the function is either *SELECT or *DISPLAY, this value is 0 indicating no output is returned.</p></dd>
|
|
|
|
<dt><strong>Number of array elements</strong></dt>
|
|
<dd>OUTPUT; BINARY(4)
|
|
|
|
<p>For the values *SELECT and *OPTSELECT, the number of users that is returned. The maximum value is the total of the maximum entries for addressees parameter plus the maximum entries for copy list parameter.</p></dd>
|
|
|
|
<dt><strong>Array</strong></dt>
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p>For the values *SELECT and *OPTSELECT, the array of the user IDs and addresses selected from the search function. For the format of this character parameter 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%">CHAR(1)</td>
|
|
<td align="left" valign="top" width="60%">Select option used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">1</td>
|
|
<td align="center" valign="top">1</td>
|
|
<td align="left" valign="top">CHAR(8)</td>
|
|
<td align="left" valign="top">User 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">User address</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">17</td>
|
|
<td align="center" valign="top">11</td>
|
|
<td align="left" valign="top">CHAR(50)</td>
|
|
<td align="left" valign="top">User's full name or description</td>
|
|
</tr>
|
|
</table>
|
|
<br></dd>
|
|
|
|
<dt><strong>Maximum entries for blind copy list</strong></dt>
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The maximum number of entries that can be selected to be blind copied on the distribution. This is the maximum number of entries that can be returned in the array parameter with the value of 4 in select option used field. The maximum number allowable is 100.</p>
|
|
|
|
<p>This value is used with the *OPTSELECT value of the function being requested parameter. If the function is either *SELECT or *DISPLAY, this value is 0 which indicates that no output is returned.</p></dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3>Field Descriptions</h3>
|
|
|
|
<p><strong>Select option used.</strong> The number of the option you want to use. The following are the
|
|
possible values:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td valign="top"><em>1</em></td>
|
|
<td valign="top">Addressee list</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>2</em></td>
|
|
<td valign="top">Carbon copy list (used only with *OPTSELECT)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>4</em></td>
|
|
<td valign="top">Blind copy list (used only with *OPTSELECT)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>User address.</strong> The second part of a two-part network name used in the system distribution directory and in the office applications to uniquely identify a user and to send electronic mail.</p>
|
|
|
|
<p><strong>User ID.</strong> The first part of a two-part network name used in the system distribution directory and in the office applications to uniquely identify a user.</p>
|
|
|
|
<p><strong>User's full name or description.</strong> The user's full name or any description up to 50 characters.</p>
|
|
|
|
<hr>
|
|
Exit Program 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>
|