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

889 lines
26 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>Retrieve Network Server User Attributes (QFPADRUA) 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. -->
<!-- QFPADRUA SCRIPT A converted by B2H R4.1 (346) (CMS) by V2DCIJB -->
<!-- at RCHVMW2 on 20 Aug 1999 at 12:37:54 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- NL Kryka 09/22/00 for adding CPF3C3C -->
<!-- Nancy Kryka 12196.1 server rebranding 10/30/00 V5R1 -->
<!-- Nancy Kryka 12196.1 Authority & Intro 11/06/00 V5R1 -->
<!--File Edited Oct 2001 by Janet Brauckman -->
<!-- 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>Retrieve Network Server User Attributes (QFPADRUA) API</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%">Receiver variable</td>
<td align="left" valign="top" width="20%">Output</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Length of receiver variable</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">Format 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">Profile name</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">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 Retrieve Network Server User Attributes (QFPADRUA) API retrieves the
network server attributes for a user or a group. The functions provided by this
API are similar to the Display Network Server User Attributes (DSPNWSUSRA)
command.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>User profile</em></dt>
<dd>*READ</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Receiver variable</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>The receiver variable that receives the information requested. You can
specify the size of the area to be smaller than the format requested as long as
you specify the length parameter correctly. As a result, the API returns only
the data the area can hold.</p>
</dd>
<dt><strong>Length of receiver variable</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the receiver variable provided. The length of the receiver
variable parameter may be specified up to the size of the receiver variable
specified in the user program. If the length of the receiver variable parameter
specified is larger than the allocated size of the receiver variable specified
in the user program, the results are not predictable. The minimum length is 8
bytes.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the information returned. Indicates whether this call is
interested in the user characteristics of the profile or the group
characteristics of the profile. Profiles can behave as both user and group
profiles, and unique enrollment characteristics can be set for each aspect of
the profile. You must use one of the following format names:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>DRUA0100</em></td>
<td align="left" valign="top">The output network server user attributes
structure. For more information, see <a href="#HDRFDRUA0100">DRUA0100
Format</a>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>DRUA0200</em></td>
<td align="left" valign="top">The output network server group attributes
structure. For more information, see <a href="#HDRFDRUA0200">DRUA0200
Format</a>.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Profile name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The name of the user or group profile whose network server attributes are to
be retrieved. The values can be:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NWSA</em></td>
<td align="left" valign="top">The system default network server attributes
defined by the Change Network Server Attributes (CHGNWSA) command are
retrieved. This value is allowed only when format DRUA0100 is specified.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Name</em></td>
<td align="left" valign="top">The network server attributes for the specified
user or group profile are retrieved.</td>
</tr>
</table>
<p><strong>Usage note:</strong> Avoid the use of characters '5B'X, '7B'X, and
'7C'X (CCSID 37 characters '$', '#', and '@', respectively) in profile
names.</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>. If this
parameter is omitted, diagnostic and escape messages are issued to the
application.</p>
</dd>
</dl>
<br>
<h3><a name="HDRODRUAFMT">Format of the Retrieved Information</a></h3>
<p>The formats of the information retrieved by this API are listed below. The
caller should pass a receiver variable large enough to handle most requests. On
return, the bytes available field of the receiver variable will contain the
required size of the receiver variable to hold all information from the
request. If this is greater than the original receiver variable size passed in,
then the caller must allocate a larger receiver variable before retrying the
operation.</p>
<br>
<h3><a name="HDRFDRUA0100">DRUA0100 Format</a></h3>
<p>The following table shows the format of the network server user
attributes.</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%">Bytes returned</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Bytes available</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(12)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset Windows domain list</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">Length Windows domain entries</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">Number Windows domains</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">Offset Windows server list</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length Windows server entries</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">Number Windows servers</td>
</tr>
<tr>
<td align="center" valign="top">See note</td>
<td align="center" valign="top">See note</td>
<td align="left" valign="top">See <a href="#HDRODRUANTD">Format of Windows
domain information</a></td>
<td align="left" valign="top">Windows domain list</td>
</tr>
<tr>
<td align="center" valign="top">See note</td>
<td align="center" valign="top">See note</td>
<td align="left" valign="top">See <a href="#HDRODRUANTS">Format of Windows
server information</a></td>
<td align="left" valign="top">Windows server list</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong>The offsets to
the Windows domain list and Windows server list are specified in the offset
Windows domain list and offset Windows server list variables,
respectively.</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRFDRUA0200">DRUA0200 Format</a></h4>
<p>The following table show the format of the network server group
attributes.</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%">Bytes returned</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Bytes available</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Group member enrollment</td>
</tr>
<tr>
<td align="center" valign="top">18</td>
<td align="center" valign="top">12</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset Windows domain list</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">Length Windows domain entries</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">Number Windows domains</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">Offset Windows server list</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length Windows server entries</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">Number Windows servers</td>
</tr>
<tr>
<td align="center" valign="top">See note</td>
<td align="center" valign="top">See note</td>
<td align="left" valign="top">See <a href="#HDRODRUANTD">Format of Windows
domain information</a></td>
<td align="left" valign="top">Windows domain list</td>
</tr>
<tr>
<td align="center" valign="top">See note</td>
<td align="center" valign="top">See note</td>
<td align="left" valign="top">See <a href="#HDRODRUANTS">Format of Windows
server information</a></td>
<td align="left" valign="top">Windows server list</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> The offsets to
the Windows domain list and Windows server list are specified in the offset
Windows domain list and offset Windows server list variables,
respectively.</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRODRUAFD0">DRUA0100 and DRUA0200 Field Descriptions</a></h3>
<p><strong>Bytes available.</strong> The length of all data available for the
requested format. All available data is returned if enough space is
provided.</p>
<p><strong>Bytes returned.</strong> The length of all data actually returned.
If the data is truncated because the receiver variable is not large enough to
hold the data, this value is less than the bytes available.</p>
<p><strong>Group member enrollment.</strong> This field indicates whether or
not the group members (users in the group) are enrolled to the server. This
field is only returned for format DRUA0200. The following are the valid values
for this field:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">The group and the users in the group are enrolled
to the servers.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*MBRONLY</em></td>
<td align="left" valign="top">Only the users in the group are enrolled to the
servers. The group itself is not enrolled to the servers.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">Only the group is enrolled to the servers. The
users in the group are not enrolled to the servers.</td>
</tr>
</table>
<p><strong>Length Windows domain entries.</strong> The length in bytes of each
element in the list of Windows domains.</p>
<p><strong>Length Windows server entries.</strong> The length in bytes of each
element in the list of Windows servers.</p>
<p><strong>Number Windows domains.</strong> The number of entries in the list
of Windows domain names. If this value is 0, then there are no Windows domains
in the list.</p>
<p><strong>Number Windows servers.</strong> The number of entries in the list
of Windows server names. If this value is 0, then there are no Windows servers
in the list.</p>
<p><strong>Offset Windows domain list.</strong> The offset from the start of
the receiver variable to the list of Windows domain entries. A value of zero
indicates there are no list entries. See <a href="#HDRODRUANTD">Format of
Windows domain information</a> for details of the individual entries.</p>
<p><strong>Offset Windows server list.</strong> The offset from the start of
the receiver variable to the list of Windows server entries. A value of zero
indicates there are no list entries. See <a href="#HDRODRUANTS">Format of
Windows server information</a> for details of the individual entries.</p>
<p><strong>Reserved.</strong> Reserved space.</p>
<p><strong>Windows domain list.</strong> The list of Windows domain entries.
See <a href="#HDRODRUANTD">Format of Windows domain information</a> for details
of the individual entries.</p>
<p><strong>Windows server list.</strong> The list of Windows server entries.
See <a href="#HDRODRUANTS">Format of Windows server information</a> for details
of the individual entries.</p>
<br>
<h3><a name="HDRODRUANTD">Format of Windows domain information</a></h3>
<p>The following table describes the layout of the information returned to
describe a Windows domain. To locate the first such entry, add the receiver
variable start to the value in 'Offset Windows domain list' noted above. Each
succeeding entry can be located by adding the 'Length Windows domain entries'
size to the address of the current entry.</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(10)</td>
<td align="left" valign="top" width="60%">Windows group type</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</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">Displacement to Windows domain name</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">Length of Windows domain name</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to Windows user template name</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">Length of Windows user template name</td>
</tr>
<tr>
<td align="center" valign="top">See Note</td>
<td align="center" valign="top">See Note</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Windows domain name</td>
</tr>
<tr>
<td align="center" valign="top">See Note</td>
<td align="center" valign="top">See Note</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Windows user template name</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> The
displacement to the Windows domain name and Windows user template name are
specified in the displacement to Windows domain name and displacement to
Windows user template name variables, respectively.</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRODRUAFD5">Windows Domain Field Descriptions</a></h3>
<p><strong>Displacement to Windows domain name.</strong> The displacement in
bytes from the beginning of the entry to the Windows domain name.</p>
<p><strong>Displacement to Windows user template name.</strong> The
displacement in bytes from the beginning of the entry to the Windows user
template name.</p>
<p><strong>Length of Windows domain name.</strong> The length of the Windows
domain name.</p>
<p><strong>Length of Windows user template name.</strong> The length of the
Windows user template name.</p>
<p><strong>Reserved.</strong> Reserved space.</p>
<p><strong>Windows domain name.</strong> This is the name of a domain in which
the user is enrolled. The values can be:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NWSA</em></td>
<td align="left" valign="top">The user is enrolled to the system default
domains that are defined by the Change Network Server Attributes (CHGNWSA)
command.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Name</em></td>
<td align="left" valign="top">The specific name of the domain in which the user
is enrolled.</td>
</tr>
</table>
<p><strong>Windows group type.</strong> This is the type of group created on a
Windows domain.</p>
<p>The values can be:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*GLOBAL</em></td>
<td align="left" valign="top">A global group was created.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LOCAL</em></td>
<td align="left" valign="top">A local group was created.</td>
</tr>
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">Blanks are returned if retrieving user
attributes.</td>
</tr>
</table>
<p><strong>Windows user template name.</strong> The name of a Windows user that
was used as a template when creating the specified user on Windows. The values
can be:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No user template was used when creating the
specified user.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Name</em></td>
<td align="left" valign="top">The specific name of the user template that was
used when creating the specified user.</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRODRUANTS">Format of Windows server information</a></h3>
<p>The following table describes the layout of the information returned to
describe a Windows server. To locate the first such entry, add the receiver
variable start to the value in 'Offset Windows server list' noted above. Each
succeeding entry can be located by adding the 'Length Windows server entries'
size to the address of the current entry.</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 Windows server
name</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of Windows server name</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to Windows user template name</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">Length of Windows user template name</td>
</tr>
<tr>
<td align="center" valign="top">See Note</td>
<td align="center" valign="top">See Note</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Windows server name</td>
</tr>
<tr>
<td align="center" valign="top">See Note</td>
<td align="center" valign="top">See Note</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Windows user template name</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> The
displacement to the Windows server name and Windows user template name are
specified in the displacement to Windows server name and displacement to
Windows user template name variables, respectively.</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRODRUAFD6">Windows Server Field Descriptions</a></h3>
<p><strong>Displacement to Windows server name.</strong> The displacement in
bytes from the beginning of the entry to the Windows server name.</p>
<p><strong>Displacement to Windows user template name.</strong> The
displacement in bytes from the beginning of the entry to the Windows user
template name.</p>
<p><strong>Length of Windows server name.</strong> The length of the Windows
server name.</p>
<p><strong>Length of Windows user template name.</strong> The length of the
Windows user template name.</p>
<p><strong>Windows server name.</strong> The name of a server in which the user
is enrolled. The values can be:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NWSA</em></td>
<td align="left" valign="top">The user is enrolled to the system default
servers that are defined by the Change Network Server Attributes (CHGNWSA)
command.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Name</em></td>
<td align="left" valign="top">The specific name of the server in which the user
is enrolled.</td>
</tr>
</table>
<p><strong>Windows user template name.</strong> The name of a Windows user that
was used as a template when creating the specified user on Windows. The values
can be:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No user template was used when creating the
specified user.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Name</em></td>
<td align="left" valign="top">The specific name of the user template that was
used when creating the specified user.</td>
</tr>
</table>
<br>
<br>
<h3>Error Messages</h3>
<table width="100%">
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPF2204 E</td>
<td width="85%" valign="top">User profile &amp;1 not found.</td>
</tr>
<tr>
<td valign="top">CPF24B4 E</td>
<td valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td valign="top">CPF2634 E</td>
<td valign="top">Not authorized to object &amp;1.</td>
</tr>
<tr>
<td valign="top">CPF3C19 E</td>
<td valign="top">Error occurred with receiver variable specified.</td>
</tr>
<tr>
<td valign="top">CPF3C21 E</td>
<td valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C24 E</td>
<td valign="top">Length of the receiver variable is not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C3C E</td>
<td valign="top">Value for parameter &amp;1 not valid.</td>
</tr>
<tr>
<td valign="top">CPF3CF1 E</td>
<td valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td 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>
<tr>
<td valign="top">CPF9999 E</td>
<td valign="top">Function check. &amp;1 unmonitored by &amp;2 at statement
&amp;5, instruction &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V5R1<br>
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"ss1.htm">Server Support APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
</body>
</html>