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

237 lines
6.5 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>Add Server Authentication Entry (QsyAddServerEntry) 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. -->
<!-- Sec SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- Edited by Kersten Jan 02 -->
<!--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>Add Server Authentication Entry (QsyAddServerEntry) API</h2>
<div class="box" style="width: 65%;">
<br>
&nbsp;&nbsp;<img src="delta.gif" alt="Start of change">Syntax for QsyAddServerEntry:<br>
<pre>
#include &lt;qsysvrfn.h&gt;
void QsyAddServerEntry
(char <em>User_profile</em>[10],
char *<em>Server_name</em>,
int <em>Length_of_server_name</em>,
char *<em>User_ID</em>,
int <em>Length_of_user_ID</em>,
char *<em>Password</em>,
int <em>Length_of_password</em>,
void *<em>Error_code</em>);
</pre>
&nbsp;&nbsp;Service Program: QSYSVRFN<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<img src="deltaend.gif" alt="End of change"><br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Add Server Authentication Entry (QsyAddServerEntry) API adds server
authentication information for use by application requesters in connecting to
application servers.</p>
<p>When adding a server authentication entry for a Distributed Relational
Database Architecture (DRDA) application that uses TCP/IP, the server name must
be entered in upper case.</p>
<br>
<h3>Authorities and Locks</h3>
<p>If the user profile parameter is not *CURRENT or the user profile currently
running, then the user profile that calls this API must have *SECADM special
authority and *OBJMGT and *USE authorities to the user profile.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>User profile</strong></dt>
<dd>INPUT; CHAR(10)
<p>The user profile for which the server authentication entry will be added.
The special value *CURRENT may be specified to add an entry for the user
profile that calls this API.</p>
</dd>
<dt><strong>Server name</strong></dt>
<dd>INPUT; CHAR(*)
<p>The name of the application server.</p>
</dd>
<dt><strong>Length of server name</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the server name that is specified in the server name
parameter. The length of the server name must be a value from 1 to 200.</p>
</dd>
<dt><strong>User ID</strong></dt>
<dd>INPUT; CHAR(*)
<p>The user name for which requests will be made to the implementation
server.</p>
</dd>
<dt><strong>Length of user ID</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the user ID that is specified in the user ID parameter. The
length of the user ID must be a value from 0 to 1000. If the length is 0, the
user ID will be the same as the name that is specified in the user profile
parameter.</p>
</dd>
<dt><strong>Password</strong></dt>
<dd>INPUT; CHAR(*)
<p>The password to be used to authenticate the user when the client attempts to
connect to the server.</p>
</dd>
<dt><strong>Length of password</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the password that is specified in the password parameter. The
length of the password must be a value from 0 to 696. If the length is 0, then
no password is supplied on the connection request. If the retain server
security data (QRETSVRSEC) system value is set to 0 (do not retain data), then
the length of the password is assumed to be 0.</p>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
</dd>
</dl>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<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 align="left" valign="top">CPF2213 E</td>
<td align="left" valign="top">Not able to allocate user profile &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2222 E</td>
<td align="left" valign="top">Storage limit is greater than specified for user
profile &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF224F E</td>
<td align="left" valign="top">Server authentication entry already exists.</td>
</tr>
<tr>
<td align="left" valign="top">CPF225F E</td>
<td align="left" valign="top">Not all information stored.</td>
</tr>
<tr>
<td align="left" valign="top">CPF226C E</td>
<td align="left" valign="top">Not authorized to perform function.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF2 E</td>
<td align="left" valign="top">Error(s) occurred during running of &amp;1
API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C1D E</td>
<td align="left" valign="top">Length specified in parameter &amp;1 not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V4R2
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"sec.htm">Security APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>