ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/XDIRVERI.htm

2335 lines
65 KiB
HTML
Raw 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">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Directory Maintenance 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 Maintenance Exit Program</h2>
<div class="box" style="width: 80%;">
<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%">Request type</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">Directory information format</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Owning system name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">User making request</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">System making request</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Length of directory information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">Directory information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="left" valign="top">User exit program type</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">9</td>
<td align="left" valign="top">Field name and product ID in error</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Char(17)</td>
</tr>
</table>
<pre>
QSYSINC Member Name: EOKDRVF
Exit Point Name: QIBM_QOK_VERIFY
QIBM_QOK_NOTIFY
Exit Point Format Name: VRFY0100
</pre>
</div>
<p>The Directory Maintenance exit program allows the administrator to make
decisions based on directory entry additions, changes, or deletions. Two exit
points are available.</p>
<p>The maintenance program registered at exit point QIBM_QOK_VERIFY is called
before any directory entry, department, or location is added, changed, or
removed from the system. This exit program is more specifically known as the
verification maintenance exit program. The verification maintenance exit
program allows the administrator to define additional security or syntax
checking on the data.</p>
<p>The maintenance program registered at exit point QIBM_QOK_NOTIFY is called
after any directory entry, department, or location is added, changed, or
removed from the system. This exit program is more specifically known as the
notification maintenance exit program.</p>
<p>The verification maintenance exit program is specified on the VRFPGM
parameter of the Change System Directory Attribute (CHGSYSDIRA) command. The
verification maintenance exit program can also be specified using the Work with
Registration Information (WRKREGINF) command. The notification maintenance exit
program can only be specified using the Work with Registration Information
(WRKREGINF) command.</p>
<p>Exit programs that have been registered through the registration facility
for common exit programs can be viewed by using the Work with Registration
Information (WRKREGINF) command.</p>
<p>The maintenance programs are given all updated information known about the
directory entry, department, or location. The verification maintenance exit
program returns to the directory service an indication as to whether the add,
change, or delete operation is to be applied to the Enterprise Address Book
(EAB). On the iSeries server, this is called the system distribution directory.
The EAB is a collection of data, such as information about people, departments,
and locations in a network. An example of an enterprise is a company.</p>
<p>Whether or not update requests that are rejected by the verification
maintenance exit program are supplied to other systems depends on the origin of
the update.</p>
<ul>
<li>When a local update request is rejected by the verification maintenance
exit program, the update does not affect the local system. If the iSeries
server is participating in directory shadowing, the update is not supplied to
other systems in the directory shadowing network.<br>
<br>
</li>
<li>If the iSeries server is participating in directory shadowing and a
shadowed update request is received and is rejected by the verification
maintenance exit program, then the update does not affect the local system.
<p>Other systems in the directory shadowing network may be affected. The
results depend on the nature of the shadowed update request:</p>
<ul>
<li>When an add request is rejected, it is filtered out of (does not appear on)
the local system, but remains on the network. Information about the add request
is stored separately in a change log and will subsequently be supplied to other
systems in the directory shadowing network.<br>
<br>
</li>
<li>When a change or delete request is rejected, the local system keeps its
original information. In addition, the original information will be supplied
again to other systems, including the system the information originated from,
to keep directory information consistent throughout the network.</li>
</ul>
</li>
</ul>
<p>The verification criteria should be consistent on all your systems to help
reduce the amount of processing on the network.</p>
<p>The system can get back the data which was filtered, but it is not a simple
task. In order to retrieve the data which has been filtered out, the data can
be shadowed again from the system where the data resides.</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 operation that the user is requesting to do to the directory
information that is described by the other parameters.</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>*ADD</em></td>
<td valign="top">Information is being added.</td>
</tr>
<tr>
<td valign="top"><em>*ADDDSC</em></td>
<td valign="top">User description is being added.</td>
</tr>
<tr>
<td valign="top"><em>*CHG</em></td>
<td valign="top">Information is being changed.
<p>All fields in the directory information that are not changed will be X'00'
except for the first field of every table. That field indicates what directory
entry, department, or location is being changed.</p>
</td>
</tr>
<tr>
<td valign="top"><em>*DLT</em></td>
<td valign="top">Information is being deleted.</td>
</tr>
<tr>
<td valign="top"><em>*DLTDSC</em></td>
<td valign="top">User description is being deleted.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Directory information format</strong></dt>
<dd>INPUT; CHAR(10)
<p>The format of the directory information that is being worked with. The
information is provided in the directory information parameter. The valid
formats are:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>CHKP0100</em></td>
<td valign="top">Directory entry (See <a href="#HDRCH100">CHKP0100
Format</a>.)</td>
</tr>
<tr>
<td valign="top"><em>CHKP0200</em></td>
<td valign="top">Department entry (See <a href="#HDRCH200">CHKP0200
Format</a>.)</td>
</tr>
<tr>
<td valign="top"><em>CHKP0300</em></td>
<td valign="top">Location entry (See <a href="#HDRCH300">CHKP0300
Format</a>.)</td>
</tr>
</table>
<p>These formats have the same layout as the SUPP0100, SUPP0200, and SUPP0300
formats used for the Directory Supplier exit program. This allows a single
program to be used as both a verification maintenance program and a supplier
program.</p>
</dd>
<dt><strong>Owning system name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The name of the system that "owns" the directory entry, department, or
location that is being worked with. The owning system is the system that
originally added the data to the network.</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>*LOCAL</em></td>
<td valign="top">The entry is owned by the local system.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>User making request</strong></dt>
<dd>INPUT; CHAR(10)
<p>The user profile name of the user that is doing the request. When using the
shadowing function, this is the user that originated the modification.<br>
<br>
</p>
</dd>
<dt><strong>System making request</strong></dt>
<dd>INPUT; CHAR(8)
<p>The system from which the request is coming. When using the shadowing
function, this is the system that originated the modification.</p>
</dd>
<dt><strong>Length of directory information</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the directory information in the directory information
parameter. The length depends on the directory information format. Each format
has a different (but fixed) length as shown in specific format tables.</p>
</dd>
<dt><strong>Directory information</strong></dt>
<dd>INPUT; CHAR(*)
<p>The directory information that is associated with the directory entry,
department, or location that the request is made against. For the format of
this character parameter, refer to the specific format table (<a href=
"#HDRCH100">CHKP0100 Format</a>&nbsp;, <a href="#HDRCH200">CHKP0200
Format</a>&nbsp;, or <a href="#HDRCH300">CHKP0300 Format</a>) and to the <a
href="#HDROEOFL">Field Descriptions</a>.</p>
</dd>
<dt><strong>User exit program type</strong></dt>
<dd>INPUT; CHAR(10)
<p>The user exit program type that is associated with the call of the Directory
Maintenance exit program. This parameter is provided so that a single program
can be used as both a maintenance program and a supplier program. This
parameter is set to *VRFPGM if calling the verification maintenance exit
program or *NFYPGM if calling the notification maintenance exit program.</p>
</dd>
<dt><strong>Field name and product ID in error</strong></dt>
<dd>OUTPUT; CHAR(17)
<p>The field name and product ID that caused the CPF89A4 error. The first 10
characters are the field name; the second 7 characters contain the product
name. The product ID can have the following special values:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>*NONE</em></td>
<td valign="top">A field name that does not have a product ID.</td>
</tr>
<tr>
<td valign="top"><em>*IBM</em></td>
<td valign="top">A field defined by the i5/OS system distribution
directory.</td>
</tr>
</table>
<p>This parameter is used only by the verification maintenance exit program.
The notification maintenance exit program does not use any output parameter.
This is because the information has already been added to the directory and the
notification maintenance exit program cannot reject it.</p>
<p>This field will be recognized only for an add or a change of a directory
entry where the Work with Directory Entries (WRKDIRE) panel support is being
used. The field will be highlighted and the cursor will be positioned on the
field. The field will be ignored under any other conditions.</p>
<p>The field name can be a user-defined name or a name supplied by the i5/OS
system distribution directory. To display the user-defined names, either type
CHGSYSDIRA and press F4, or use the SREQ0200 format of the QOKSCHD API. For
more information on the SREQ0200 format of the QOKSCHD API, see <a href=
"QOKSCHD.htm#HDRD20">SREQ0200 Format</a>.</p>
<p>The following names are defined by the i5/OS system distribution directory.
The product ID of these names is *IBM.</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>LSTNAM</em></td>
<td valign="top">Last name</td>
</tr>
<tr>
<td valign="top"><em>FSTNAM</em></td>
<td valign="top">First name</td>
</tr>
<tr>
<td valign="top"><em>MIDNAM</em></td>
<td valign="top">Middle name</td>
</tr>
<tr>
<td valign="top"><em>PREFNAM</em></td>
<td valign="top">Preferred name</td>
</tr>
<tr>
<td valign="top"><em>FULNAM</em></td>
<td valign="top">Full name</td>
</tr>
<tr>
<td valign="top"><em>DEPT</em></td>
<td valign="top">Department</td>
</tr>
<tr>
<td valign="top"><em>USRID</em></td>
<td valign="top">User ID (DEN)</td>
</tr>
<tr>
<td valign="top"><em>USRADDR</em></td>
<td valign="top">User address (DGN)</td>
</tr>
<tr>
<td valign="top"><em>USRD</em></td>
<td valign="top">User description</td>
</tr>
<tr>
<td valign="top"><em>SYSNAME</em></td>
<td valign="top">System name (REN)</td>
</tr>
<tr>
<td valign="top"><em>SYSGRP</em></td>
<td valign="top">System group (RGN)</td>
</tr>
<tr>
<td valign="top"><em>USER</em></td>
<td valign="top">User profile</td>
</tr>
<tr>
<td valign="top"><em>NETUSRID</em></td>
<td valign="top">Network user ID</td>
</tr>
<tr>
<td valign="top"><em>TELNBR1</em></td>
<td valign="top">Telephone number 1</td>
</tr>
<tr>
<td valign="top"><em>TELNBR2</em></td>
<td valign="top">Telephone number 1</td>
</tr>
<tr>
<td valign="top"><em>FAXTELNBR</em></td>
<td valign="top">Fax telephone number</td>
</tr>
<tr>
<td valign="top"><em>LOC</em></td>
<td valign="top">Location</td>
</tr>
<tr>
<td valign="top"><em>BLDG</em></td>
<td valign="top">Building</td>
</tr>
<tr>
<td valign="top"><em>CMPNY</em></td>
<td valign="top">Company</td>
</tr>
<tr>
<td valign="top"><em>OFC</em></td>
<td valign="top">Office</td>
</tr>
<tr>
<td valign="top"><em>TITLE</em></td>
<td valign="top">Job title</td>
</tr>
<tr>
<td valign="top"><em>ADDR1</em></td>
<td valign="top">Mailing address line 1</td>
</tr>
<tr>
<td valign="top"><em>ADDR2</em></td>
<td valign="top">Mailing address line 2</td>
</tr>
<tr>
<td valign="top"><em>ADDR3</em></td>
<td valign="top">Mailing address line 3</td>
</tr>
<tr>
<td valign="top"><em>ADDR4</em></td>
<td valign="top">Mailing address line 4</td>
</tr>
<tr>
<td valign="top"><em>INDUSR</em></td>
<td valign="top">Indirect user</td>
</tr>
<tr>
<td valign="top"><em>LCLDTA</em></td>
<td valign="top">Local data indicator</td>
</tr>
<tr>
<td valign="top"><em>TEXT</em></td>
<td valign="top">Text</td>
</tr>
<tr>
<td valign="top"><em>COUNTRY</em></td>
<td valign="top">Country or region</td>
</tr>
<tr>
<td valign="top"><em>ADMD</em></td>
<td valign="top">Administration domain</td>
</tr>
<tr>
<td valign="top"><em>PRMD</em></td>
<td valign="top">Private management domain</td>
</tr>
<tr>
<td valign="top"><em>ORG</em></td>
<td valign="top">Organization</td>
</tr>
<tr>
<td valign="top"><em>SURNAM</em></td>
<td valign="top">Surname</td>
</tr>
<tr>
<td valign="top"><em>GIVENNAM</em></td>
<td valign="top">Given name</td>
</tr>
<tr>
<td valign="top"><em>INITIALS</em></td>
<td valign="top">Initials</td>
</tr>
<tr>
<td valign="top"><em>GENQUAL</em></td>
<td valign="top">Generation qualifier</td>
</tr>
<tr>
<td valign="top"><em>ORGUNIT1</em></td>
<td valign="top">Organization unit 1</td>
</tr>
<tr>
<td valign="top"><em>ORGUNIT2</em></td>
<td valign="top">Organization unit 2</td>
</tr>
<tr>
<td valign="top"><em>ORGUNIT3</em></td>
<td valign="top">Organization unit 3</td>
</tr>
<tr>
<td valign="top"><em>ORGUNIT4</em></td>
<td valign="top">Organization unit 4</td>
</tr>
<tr>
<td valign="top"><em>DMNDFNAT1</em></td>
<td valign="top">Domain-defined attribute type 1</td>
</tr>
<tr>
<td valign="top"><em>DMNDFNAV1</em></td>
<td valign="top">Domain-defined attribute value 1</td>
</tr>
<tr>
<td valign="top"><em>DMNDFNAT2</em></td>
<td valign="top">Domain-defined attribute type 2</td>
</tr>
<tr>
<td valign="top"><em>DMNDFNAV2</em></td>
<td valign="top">Domain-defined attribute value 2</td>
</tr>
<tr>
<td valign="top"><em>DMNDFNAT3</em></td>
<td valign="top">Domain-defined attribute type 3</td>
</tr>
<tr>
<td valign="top"><em>DMNDFNAV3</em></td>
<td valign="top">Domain-defined attribute value 3</td>
</tr>
<tr>
<td valign="top"><em>DMNDFNAT4</em></td>
<td valign="top">Domain-defined attribute type 4</td>
</tr>
<tr>
<td valign="top"><em>DMNDFNAV4</em></td>
<td valign="top">Domain-defined attribute value 4</td>
</tr>
<tr>
<td valign="top"><em>CCMAILADR</em></td>
<td valign="top">cc:Mail address</td>
</tr>
<tr>
<td valign="top"><em>CCMAILCMT</em></td>
<td valign="top">cc:Mail comment</td>
</tr>
<tr>
<td valign="top"><em>MSFSRVLVL</em></td>
<td valign="top">Mail server framework service level</td>
</tr>
<tr>
<td valign="top"><em>PREFADR</em></td>
<td valign="top">Preferred address</td>
</tr>
<tr>
<td valign="top"><em>ALWSYNC</em></td>
<td valign="top">Allow synchronization</td>
</tr>
<tr>
<td valign="top"><em>DLOOWN</em></td>
<td valign="top">DLO owner</td>
</tr>
</table>
</dd>
</dl>
<br>
<h3>Rejecting an Update Operation</h3>
<p>The user-written verification maintenance exit program may reject update
requests. To do so, the verification maintenance exit program must signal a
specific program message to the directory services module that called it, and
then return. An update is rejected based on the restrictions that have been
identified. For example, if three people have authority to make updates but the
program allows only one user to do updates, then update requests by all other
users are rejected.</p>
<p>To allow a directory update request, the verification maintenance exit
program only returns to the program that called it. Two program messages have
been defined for the purpose of rejecting directory updates. The messages
are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>CPF89A3</em></td>
<td valign="top">Operation not successful due to authority reasons.</td>
</tr>
<tr>
<td valign="top"><em>CPF89A4</em></td>
<td valign="top">Operation not successful due to data validation reasons.</td>
</tr>
</table>
<p><strong>Note:</strong> The message must be signalled as an escape message. A
diagnostic or informational message can be signalled before the escape message
to give additional information about the error.</p>
<p>You may provide an optional data structure with message variable
substitution text. This will help clarify the reasons for the rejection to the
users. The optional data structure is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>CHAR(10)</em></td>
<td valign="top">The profile name of the user who requested (entered) the
update. This information is from the user making request parameter.</td>
</tr>
<tr>
<td valign="top"><em>CHAR(8)</em></td>
<td valign="top">The system name of the user who requested (entered) the
update. You can get this from the system making request parameter.</td>
</tr>
<tr>
<td valign="top"><em>CHAR(120)</em></td>
<td valign="top">A description of the reason the exit program is rejecting the
request.</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRCH100">CHKP0100 Format</a></h3>
<a name="SPTUSREXT"></a>
<table border width="80%">
<!-- cols="10 10 20 60" -->
<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="left" valign="top" colspan="4"><strong>Note:</strong> The following
fields are in code page 500 and character set 697.</td>
</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(16)</td>
<td align="left" valign="top" width="60%">User ID/address</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">System name/group</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User profile</td>
</tr>
<tr>
<td align="center" valign="top">42</td>
<td align="center" valign="top">2A</td>
<td align="left" valign="top">CHAR(47)</td>
<td align="left" valign="top">Network user ID</td>
</tr>
<tr>
<td align="center" valign="top">89</td>
<td align="center" valign="top">59</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">New user ID/address</td>
</tr>
<tr>
<td align="center" valign="top">105</td>
<td align="center" valign="top">69</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">Old user to forward from user ID/address</td>
</tr>
<tr>
<td align="center" valign="top">121</td>
<td align="center" valign="top">79</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Indirect user</td>
</tr>
<tr>
<td align="center" valign="top">122</td>
<td align="center" valign="top">7A</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Print personal mail</td>
</tr>
<tr>
<td align="center" valign="top">123</td>
<td align="center" valign="top">7B</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> The character
sets and code pages immediately follow the individual fields in the list
below.</td>
</tr>
<tr>
<td align="center" valign="top">126</td>
<td align="center" valign="top">7E</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Description</td>
</tr>
<tr>
<td align="center" valign="top">176</td>
<td align="center" valign="top">B0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">180</td>
<td align="center" valign="top">B4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">184</td>
<td align="center" valign="top">B8</td>
<td align="left" valign="top">CHAR(40)</td>
<td align="left" valign="top">Last name</td>
</tr>
<tr>
<td align="center" valign="top">224</td>
<td align="center" valign="top">E0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">228</td>
<td align="center" valign="top">E4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">232</td>
<td align="center" valign="top">E8</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">First name</td>
</tr>
<tr>
<td align="center" valign="top">252</td>
<td align="center" valign="top">FC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">256</td>
<td align="center" valign="top">100</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">260</td>
<td align="center" valign="top">104</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Middle name</td>
</tr>
<tr>
<td align="center" valign="top">280</td>
<td align="center" valign="top">118</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">284</td>
<td align="center" valign="top">11C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">288</td>
<td align="center" valign="top">120</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Preferred name</td>
</tr>
<tr>
<td align="center" valign="top">308</td>
<td align="center" valign="top">134</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">312</td>
<td align="center" valign="top">138</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">316</td>
<td align="center" valign="top">13C</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">318</td>
<td align="center" valign="top">13E</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Full name</td>
</tr>
<tr>
<td align="center" valign="top">368</td>
<td align="center" valign="top">170</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">372</td>
<td align="center" valign="top">174</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">376</td>
<td align="center" valign="top">178</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">378</td>
<td align="center" valign="top">17A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Department</td>
</tr>
<tr>
<td align="center" valign="top">388</td>
<td align="center" valign="top">184</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">392</td>
<td align="center" valign="top">188</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">396</td>
<td align="center" valign="top">18C</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">398</td>
<td align="center" valign="top">18E</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Job title</td>
</tr>
<tr>
<td align="center" valign="top">448</td>
<td align="center" valign="top">1C0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">452</td>
<td align="center" valign="top">1C4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">456</td>
<td align="center" valign="top">1C8</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">458</td>
<td align="center" valign="top">1CA</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Company</td>
</tr>
<tr>
<td align="center" valign="top">508</td>
<td align="center" valign="top">1FC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">512</td>
<td align="center" valign="top">200</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">516</td>
<td align="center" valign="top">204</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">518</td>
<td align="center" valign="top">206</td>
<td align="left" valign="top">CHAR(26)</td>
<td align="left" valign="top">Telephone number 1</td>
</tr>
<tr>
<td align="center" valign="top">544</td>
<td align="center" valign="top">220</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">548</td>
<td align="CENTER" valign="TOP">224</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">552</td>
<td align="center" valign="top">228</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">554</td>
<td align="center" valign="top">22A</td>
<td align="left" valign="top">CHAR(26)</td>
<td align="left" valign="top">Telephone number 2</td>
</tr>
<tr>
<td align="center" valign="top">580</td>
<td align="center" valign="top">244</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">584</td>
<td align="center" valign="top">248</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">588</td>
<td align="center" valign="top">24C</td>
<td align="left" valign="top">CHAR(40)</td>
<td align="left" valign="top">Location</td>
</tr>
<tr>
<td align="center" valign="top">628</td>
<td align="center" valign="top">274</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">632</td>
<td align="center" valign="top">278</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">636</td>
<td align="center" valign="top">27C</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Building</td>
</tr>
<tr>
<td align="center" valign="top">656</td>
<td align="center" valign="top">290</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">660</td>
<td align="center" valign="top">294</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">664</td>
<td align="center" valign="top">298</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">Office</td>
</tr>
<tr>
<td align="center" valign="top">680</td>
<td align="center" valign="top">2A8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">684</td>
<td align="center" valign="top">2AC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">688</td>
<td align="center" valign="top">2B0</td>
<td align="left" valign="top">CHAR(40)</td>
<td align="left" valign="top">Mailing address line 1</td>
</tr>
<tr>
<td align="center" valign="top">728</td>
<td align="center" valign="top">2D8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">732</td>
<td align="center" valign="top">2DC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">736</td>
<td align="center" valign="top">2E0</td>
<td align="left" valign="top">CHAR(40)</td>
<td align="left" valign="top">Mailing address line 2</td>
</tr>
<tr>
<td align="center" valign="top">776</td>
<td align="center" valign="top">308</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">780</td>
<td align="center" valign="top">30C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">784</td>
<td align="center" valign="top">310</td>
<td align="left" valign="top">CHAR(40)</td>
<td align="left" valign="top">Mailing address line 3</td>
</tr>
<tr>
<td align="center" valign="top">824</td>
<td align="center" valign="top">338</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">828</td>
<td align="center" valign="top">33C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">832</td>
<td align="center" valign="top">340</td>
<td align="left" valign="top">CHAR(40)</td>
<td align="left" valign="top">Mailing address line 4</td>
</tr>
<tr>
<td align="center" valign="top">872</td>
<td align="center" valign="top">368</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">876</td>
<td align="center" valign="top">36C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">880</td>
<td align="center" valign="top">370</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">882</td>
<td align="center" valign="top">372</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Text</td>
</tr>
<tr>
<td align="center" valign="top">932</td>
<td align="center" valign="top">3A4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">936</td>
<td align="center" valign="top">3A8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">940</td>
<td align="center" valign="top">3AC</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Print cover page</td>
</tr>
<tr>
<td align="center" valign="top">941</td>
<td align="center" valign="top">3AD</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Mail notification</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> The following
X.400 fields are in the character set and code page as defined by 1984 X.400
standards.</td>
</tr>
<tr>
<td align="center" valign="top">942</td>
<td align="center" valign="top">3AE</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">X.400 country or region</td>
</tr>
<tr>
<td align="center" valign="top">945</td>
<td align="center" valign="top">3B1</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">X.400 administration domain</td>
</tr>
<tr>
<td align="center" valign="top">961</td>
<td align="center" valign="top">3C1</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">X.400 private domain</td>
</tr>
<tr>
<td align="center" valign="top">977</td>
<td align="center" valign="top">3D1</td>
<td align="left" valign="top">CHAR(64)</td>
<td align="left" valign="top">X.400 organization</td>
</tr>
<tr>
<td align="center" valign="top">1041</td>
<td align="center" valign="top">411</td>
<td align="left" valign="top">CHAR(40)</td>
<td align="left" valign="top">X.400 surname</td>
</tr>
<tr>
<td align="center" valign="top">1081</td>
<td align="center" valign="top">439</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">X.400 given name</td>
</tr>
<tr>
<td align="center" valign="top">1097</td>
<td align="center" valign="top">449</td>
<td align="left" valign="top">CHAR(5)</td>
<td align="left" valign="top">X.400 initials</td>
</tr>
<tr>
<td align="center" valign="top">1102</td>
<td align="center" valign="top">44E</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">X.400 generation qualifier</td>
</tr>
<tr>
<td align="center" valign="top">1105</td>
<td align="center" valign="top">451</td>
<td align="left" valign="top">CHAR(32)</td>
<td align="left" valign="top">X.400 organization unit 1</td>
</tr>
<tr>
<td align="center" valign="top">1137</td>
<td align="center" valign="top">471</td>
<td align="left" valign="top">CHAR(32)</td>
<td align="left" valign="top">X.400 organization unit 2</td>
</tr>
<tr>
<td align="center" valign="top">1169</td>
<td align="center" valign="top">491</td>
<td align="left" valign="top">CHAR(32)</td>
<td align="left" valign="top">X.400 organization unit 3</td>
</tr>
<tr>
<td align="center" valign="top">1201</td>
<td align="center" valign="top">4B1</td>
<td align="left" valign="top">CHAR(32)</td>
<td align="left" valign="top">X.400 organization unit 4</td>
</tr>
<tr>
<td align="center" valign="top">1233</td>
<td align="center" valign="top">4D1</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">X.400 domain attribute type 1</td>
</tr>
<tr>
<td align="center" valign="top">1241</td>
<td align="center" valign="top">4D9</td>
<td align="left" valign="top">CHAR(128)</td>
<td align="left" valign="top">X.400 domain attribute value 1</td>
</tr>
<tr>
<td align="center" valign="top">1369</td>
<td align="center" valign="top">559</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">X.400 domain attribute type 2</td>
</tr>
<tr>
<td align="center" valign="top">1377</td>
<td align="center" valign="top">561</td>
<td align="left" valign="top">CHAR(128)</td>
<td align="left" valign="top">X.400 domain attribute value 2</td>
</tr>
<tr>
<td align="center" valign="top">1505</td>
<td align="center" valign="top">5E1</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">X.400 domain attribute type 3</td>
</tr>
<tr>
<td align="center" valign="top">1513</td>
<td align="center" valign="top">5E9</td>
<td align="left" valign="top">CHAR(128)</td>
<td align="left" valign="top">X.400 domain attribute value 3</td>
</tr>
<tr>
<td align="center" valign="top">1641</td>
<td align="center" valign="top">669</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">X.400 domain attribute type 4</td>
</tr>
<tr>
<td align="center" valign="top">1649</td>
<td align="center" valign="top">671</td>
<td align="left" valign="top">CHAR(128)</td>
<td align="left" valign="top">X.400 domain attribute value 4</td>
</tr>
<tr>
<td align="center" valign="top">1777</td>
<td align="center" valign="top">6F1</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">1780</td>
<td align="center" valign="top">6F4</td>
<td align="left" valign="top">CHAR(32)</td>
<td align="left" valign="top">Fax telephone number</td>
</tr>
<tr>
<td align="center" valign="top">1812</td>
<td align="center" valign="top">714</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">1816</td>
<td align="center" valign="top">718</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">1820</td>
<td align="center" valign="top">71C</td>
<td align="left" valign="top">CHAR(17)</td>
<td align="left" valign="top">Mail service level</td>
</tr>
<tr>
<td align="center" valign="top">1837</td>
<td align="center" valign="top">72D</td>
<td align="left" valign="top">CHAR(29)</td>
<td align="left" valign="top">Preferred address</td>
</tr>
<tr>
<td align="center" valign="top">1866</td>
<td align="center" valign="top">74A</td>
<td align="left" valign="top">CHAR(255)</td>
<td align="left" valign="top">cc:Mail address</td>
</tr>
<tr>
<td align="center" valign="top">2121</td>
<td align="center" valign="top">849</td>
<td align="left" valign="top">CHAR(126)</td>
<td align="left" valign="top">cc:Mail comment</td>
</tr>
<tr>
<td align="center" valign="top">2247</td>
<td align="center" valign="top">8C7</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Allow synchronization</td>
</tr>
<tr>
<td align="center" valign="top">2248</td>
<td align="center" valign="top">8C8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to user-defined fields array</td>
</tr>
<tr>
<td align="center" valign="top">2252</td>
<td align="center" valign="top">8CC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of elements (fields) in user-defined
fields array</td>
</tr>
<tr>
<td align="center" valign="top">2256</td>
<td align="center" valign="top">8D0</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">DLO owner</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> All fields
that are not changed will be X'00' except for the user ID/address field.</td>
</tr>
</table>
<br>
<br>
<h3>Array for User-Defined Fields</h3>
<p>The following table is the array for user-defined fields, format
CHKP0100.</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(4)</td>
<td align="left" valign="top" width="60%">Displacement to next user-defined
field element in this array</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Field name</td>
</tr>
<tr>
<td align="center" valign="top">14</td>
<td align="center" valign="top">E</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Product ID</td>
</tr>
<tr>
<td align="center" valign="top">21</td>
<td align="center" valign="top">15</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of field value returned</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Field value</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRCH200">CHKP0200 Format</a></h3>
<table border width="80%">
<!-- cols="10 10 20 60" -->
<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="left" valign="top" colspan="4"><strong>Note:</strong> The character
sets and code pages immediately follow the individual fields in the list
below.</td>
</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(2)</td>
<td align="left" valign="top" width="60%">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="center" valign="top">2</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Department</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">22</td>
<td align="center" valign="top">16</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Title</td>
</tr>
<tr>
<td align="center" valign="top">72</td>
<td align="center" valign="top">48</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">76</td>
<td align="center" valign="top">4C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">80</td>
<td align="center" valign="top">50</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">82</td>
<td align="center" valign="top">52</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Reports to department</td>
</tr>
<tr>
<td align="center" valign="top">92</td>
<td align="center" valign="top">5C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">96</td>
<td align="center" valign="top">60</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> The following
field is in code page 500 and character set 697.</td>
</tr>
<tr>
<td align="center" valign="top">100</td>
<td align="center" valign="top">64</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">Manager user ID/address</td>
</tr>
<tr>
<td align="center" valign="top">116</td>
<td align="center" valign="top">74</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">118</td>
<td align="center" valign="top">76</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Old department</td>
</tr>
<tr>
<td align="center" valign="top">128</td>
<td align="center" valign="top">80</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">132</td>
<td align="center" valign="top">84</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> All fields
that are not changed will be X'00' except for the department field and its
corresponding character set and code page fields.</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRCH300">CHKP0300 Format</a></h3>
<table border width="80%">
<!-- cols="10 10 20 60" -->
<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="LEFT" valign="TOP" colspan="4"><strong>Note:</strong> The character
sets and code pages immediately follow the individual fields in the list
below.</td>
</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(40)</td>
<td align="left" valign="top" width="60%">Location</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">2C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">48</td>
<td align="center" valign="top">30</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">50</td>
<td align="center" valign="top">32</td>
<td align="left" valign="top">CHAR(30)</td>
<td align="left" valign="top">Location line 1</td>
</tr>
<tr>
<td align="center" valign="top">80</td>
<td align="center" valign="top">50</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">84</td>
<td align="center" valign="top">54</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">88</td>
<td align="center" valign="top">58</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">90</td>
<td align="center" valign="top">5A</td>
<td align="left" valign="top">CHAR(30)</td>
<td align="left" valign="top">Location line 2</td>
</tr>
<tr>
<td align="center" valign="top">120</td>
<td align="center" valign="top">78</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">124</td>
<td align="center" valign="top">7C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">128</td>
<td align="center" valign="top">80</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">130</td>
<td align="center" valign="top">82</td>
<td align="left" valign="top">CHAR(30)</td>
<td align="left" valign="top">Location line 3</td>
</tr>
<tr>
<td align="center" valign="top">160</td>
<td align="center" valign="top">A0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">164</td>
<td align="center" valign="top">A4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">168</td>
<td align="center" valign="top">A8</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">170</td>
<td align="center" valign="top">AA</td>
<td align="left" valign="top">CHAR(30)</td>
<td align="left" valign="top">Location line 4</td>
</tr>
<tr>
<td align="center" valign="top">200</td>
<td align="center" valign="top">C8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">204</td>
<td align="center" valign="top">CC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">208</td>
<td align="center" valign="top">D0</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">210</td>
<td align="center" valign="top">D2</td>
<td align="left" valign="top">CHAR(30)</td>
<td align="left" valign="top">Location line 5</td>
</tr>
<tr>
<td align="center" valign="top">240</td>
<td align="center" valign="top">F0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">244</td>
<td align="center" valign="top">F4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">248</td>
<td align="center" valign="top">F8</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">250</td>
<td align="center" valign="top">FA</td>
<td align="left" valign="top">CHAR(30)</td>
<td align="left" valign="top">Location line 6</td>
</tr>
<tr>
<td align="center" valign="top">280</td>
<td align="center" valign="top">118</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">284</td>
<td align="center" valign="top">11C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">288</td>
<td align="center" valign="top">120</td>
<td align="left" valign="top">CHAR(40)</td>
<td align="left" valign="top">Location changed to</td>
</tr>
<tr>
<td align="center" valign="top">328</td>
<td align="center" valign="top">148</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">332</td>
<td align="center" valign="top">14C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">336</td>
<td align="center" valign="top">150</td>
<td align="left" valign="top">CHAR(40)</td>
<td align="left" valign="top">Old location</td>
</tr>
<tr>
<td align="center" valign="top">376</td>
<td align="center" valign="top">178</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Character set</td>
</tr>
<tr>
<td align="center" valign="top">380</td>
<td align="center" valign="top">17C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> All fields
that are not changed will be X'00' except for the location field and its
corresponding character set and code page fields.</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDROEOFL">Field Descriptions</a></h3>
<p><strong>Allow synchronization.</strong> Whether the directory entries should
be synchronized with directories other than the system distribution directory.
The values are 0 for no and 1 for yes.</p>
<p><strong>Building.</strong> The name or number that identifies the user's
building.</p>
<p><strong>cc:Mail address.</strong> The cc:Mail address for a user. This field
has a maximum of 126 characters, or 255 if the cc:Mail address contains both a
remote post office name and an alias name.</p>
<p><strong>cc:Mail comment.</strong> The cc:Mail comment for this user.</p>
<p><strong>Character set.</strong> The character identifier (graphic character
set) that was used by the work station to enter the data for the field.</p>
<p><strong>Code page.</strong> The value specified on this parameter is used to
instruct the printer device to interpret the hexadecimal byte string to print
the same characters that were intended when the text was created.</p>
<p><strong>Company.</strong> The name of the company for whom the user
works.</p>
<p><strong>Department.</strong> The name or number that identifies the user's
department.</p>
<p><strong>Description.</strong> The description associated with the user ID.
One entry in the directory can have several different descriptions.</p>
<p><strong>Displacement to next user-defined field element in this
array.</strong> The displacement, in bytes, to the next user-defined field. Use
this value to increment the pointer to get to the next user-defined field.</p>
<p><strong>DLO owner.</strong> A special value indicating whether the user
profile or the group profile will be assigned ownership of newly created
document library objects (DLOs) associated with this directory entry.</p>
<p><strong>Fax telephone number.</strong> The facsimile telephone number.</p>
<p><strong>Field name.</strong> The user-defined field name.</p>
<p><strong>Field value.</strong> The value of the user-defined field. The
maximum is 512 bytes.</p>
<p><strong>First name.</strong> The user's first name or given name.</p>
<p><strong>Full name.</strong> The user's full name as it appears when a
directory is viewed or searched.</p>
<p><strong>Indirect user.</strong> A user enrolled in the system distribution
directory who receives mail but never signs on to view it. An indirect user
receives printed mail only. The values are 0 for no and 1 for yes.</p>
<p><strong>Job title.</strong> The title of the user's occupation.</p>
<p><strong>Last name.</strong> The user's last name.</p>
<p><strong>Length of field value.</strong> The length of the user-defined field
value. If the value is 0, there is no data in that field for this user.</p>
<p><strong>Location.</strong> The location of the business or system. Some
examples of location are city, state, or street address.</p>
<p><strong>Location changed to.</strong> The new location value after combining
locations.</p>
<p><strong>Location lines 1 through 6.</strong> The location of the business or
system. These fields further describe a location name. For example, the field
may contain the general mailing address for the location.</p>
<p><strong>Mail notification.</strong> Whether or not the user wants to be
notified when mail arrives.</p>
<p>The user can specify these values:</p>
<table cellpadding="3">
<!-- cols="10 90" -->
<tr>
<td valign="top"><em>Blank</em></td>
<td valign="top">Notified for priority or personal mail and messages</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Notified for priority or personal mail and messages</td>
</tr>
<tr>
<td valign="top"><em>2</em></td>
<td valign="top">Notified for only priority or personal mail</td>
</tr>
<tr>
<td valign="top"><em>3</em></td>
<td valign="top">Notified for messages only</td>
</tr>
<tr>
<td valign="top"><em>4</em></td>
<td valign="top">Notified for all mail</td>
</tr>
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">No notification for mail</td>
</tr>
</table>
<p><strong>Mail service level.</strong> A 17-byte field where the first 10
bytes are the field name and the last 7 bytes are the product ID. The values
for the mail service level can be:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>*USRIDX</em></td>
<td valign="top">User index</td>
</tr>
<tr>
<td valign="top"><em>*SYSMS</em></td>
<td valign="top">System message store</td>
</tr>
<tr>
<td valign="top"><em>*DOMINO</em></td>
<td valign="top">Lotus Domino mail database</td>
</tr>
<tr>
<td valign="top"><em>A user-defined field name and product ID</em></td>
<td valign="top">The product ID will be blank if the product ID does not
exist.</td>
</tr>
</table>
<p><strong>Mailing address lines 1 through 4.</strong> The address of the
user.</p>
<p><strong>Manager user ID/address.</strong> The department manager's user ID
and address.</p>
<p><strong>Middle name.</strong> The user's middle name.</p>
<p><strong>Network user ID.</strong> A unique value associated with each user
in the Enterprise Address Book. For example, the value could be the user
ID/address, the social security number, or the employee number.</p>
<p><strong>New user ID/address.</strong> The new user ID and address used
during the rename operation.</p>
<p><strong>Office.</strong> The name or number that identifies the user's
office.</p>
<p><strong>Old department.</strong> The previous department value before being
changed.</p>
<p><strong>Old location.</strong> The previous location value before being
changed.</p>
<p><strong>Old user to forward from user ID/address.</strong> This field shows
the previous user ID and address from which the user forwards mail.</p>
<p><strong>Preferred address.</strong> A 29-byte field where the first 10 bytes
are the field name, the second 7 bytes are the product ID, the third 4 bytes
are reserved, and the last 8 bytes are the address type name.</p>
<p>The special values of the field name in preferred address can be:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>*USRID</em></td>
<td valign="top">User ID/Address</td>
</tr>
<tr>
<td valign="top"><em>*ORNAME</em></td>
<td valign="top">X.400 O/R name</td>
</tr>
<tr>
<td valign="top"><em>*SMTP</em></td>
<td valign="top">SMTP name</td>
</tr>
<tr>
<td valign="top"><em>A user-defined or IBM-defined field.</em></td>
<td valign="top">The product ID is *IBM for an IBM-defined field. The product
ID will be blank if the product ID does not exist.</td>
</tr>
</table>
<p><strong>Preferred name.</strong> The name by which the user prefers to be
known.</p>
<p><strong>Product ID.</strong> The product ID of the user-defined field. If
the value is *NONE, there is no product ID.</p>
<p><strong>Print cover page.</strong> Whether a cover page is printed when the
user's mail is printed. The values are 0 for no and 1 for yes.</p>
<p><strong>Print personal mail.</strong> This field is used only if the user is
an indirect user. The value specifies whether to print the mail that can be
accessed only by the receiver, but not by someone working on behalf of the
receiver. When mail is sent, it can be assigned the classification personal.
The values are 0 for no and 1 for yes.</p>
<p><strong>Reports to department.</strong> The department to which this
department reports.</p>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>System name/group.</strong> An IBM-supplied name that uniquely
identifies the system. It is used as a network value for certain communications
applications such as APPC.</p>
<p><strong>Telephone number 1.</strong> The telephone number of the user's
office or business, or telephone numbers that are significant to the user. The
most important number should be listed on the first line because only the first
line is displayed when you use the search directory function.</p>
<p><strong>Telephone number 2.</strong> The second line for telephone
numbers.</p>
<p><strong>Text.</strong> Any additional information that describes the
entry.</p>
<p><strong>Title.</strong> A department title that further describes the
department name.</p>
<p><strong>User-defined fields.</strong> Fields that are defined on the system
by the Change System Directory Attributes (CHGSYSDIRA) command. The value of
these user-defined fields can then be filled in on the directory entry for each
user. The field name, product ID and field value are passed in the user-defined
fields array. The product ID will be blank if the product ID does not
exist.</p>
<p><strong>User ID/address.</strong> 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 profile.</strong> The user profile name, if any, associated
with a user ID and address.</p>
<p><strong>X.400 administration domain.</strong> The administration management
domain part of the X.400 originator/recipient (O/R) name. An administration
management domain is a management domain that is administered by a public
organization, such as a national Post Telephone and Telegraph Administration
(PTT). A management domain is a set of message transfer agents (MTAs) and user
agents (UAs) that comprise a message handling system.</p>
<p><strong>X.400 country or region.</strong> The country or region part of the X.400
originator/recipient (O/R) name.</p>
<p><strong>X.400 domain attribute types 1 through 4.</strong> The type of a
domain-defined attribute for this object. The domain-defined attribute is not
defined by X.400 standards but is allowed in the X.400 originator/recipient
(O/R) name to accommodate values of existing systems sending messages.</p>
<p><strong>X.400 domain attribute values 1 through 4.</strong> The code
immediately following the attribute type that specifies a particular property
from the set defined by the attribute type.</p>
<p><strong>X.400 generation qualifier.</strong> The generation qualifier part
of the X.400 originator/recipient (O/R) name. For example, the generation
qualifier in the name John R. Smith, III, is III. If you specify a generation
qualifier, you must specify an X.400 surname.</p>
<p><strong>X.400 given name.</strong> The user first name, or given name, part
of the X.400 originator/recipient (O/R) name. The default for the given name is
the equivalent of the first name. If you specify a given name, you must specify
an X.400 surname.</p>
<p><strong>X.400 initials.</strong> The first and middle initials of the X.400
originator/recipient (O/R) name. For example, the initials for John Henry Smith
are JH. If you specify initials, you must specify a surname.</p>
<p><strong>X.400 organization.</strong> The organization name part of the X.400
originator/recipient (O/R) name.</p>
<p><strong>X.400 organization units 1 through 4.</strong> The
organization-defined unit part of the X.400 originator/recipient (O/R)
name.</p>
<p><strong>X.400 private domain.</strong> The private management domain part of
the X.400 originator/recipient (O/R) name. A private management domain is a
management domain that is administered by a private company or a noncommercial
organization.</p>
<p><strong>X.400 surname.</strong> The user last name, or surname, part of the
X.400 originator/recipient (O/R) name.</p>
<br>
<h3>Error Messages</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">CPF89A3 E</td>
<td valign="top">Operation not successful due to authority reasons.</td>
</tr>
<tr>
<td align="left" valign="top">CPF89A4 E</td>
<td valign="top">Operation not successful due to data validation reasons.</td>
</tr>
</table>
<br>
<hr>
Exit Program Introduced: V3R6
<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>