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

300 lines
7.7 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>Generate Profile Token From Profile Token (QSYGENFT,
QsyGenPrfTknFromPrfTkn) 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. -->
<!-- QSYGENFT SCR450 A converted by B2H R4.1 (346) (CMS) by V2DCIJB -->
<!-- at RCHVMW2 on 2 Oct 1999 at 10:01:05 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited by Kersten Dec 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>Generate Profile Token From Profile Token (QSYGENFT,
QsyGenPrfTknFromPrfTkn) API</h2>
<p><img src="delta.gif" alt="Start of change"></p>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;Required Parameter Group for QSYGENFT:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">New profile token</td>
<td align="left" valign="top" width="20%">Output</td>
<td align="left" valign="top" width="20%">Char(32)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">From profile token</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(32)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Time out interval</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Bin(4)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">New profile token type</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(1)</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: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<br>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;Syntax for QsyGenPrfTknFromPrfTkn:<br>
<pre>
#include &lt;qsyptkn.h&gt;
void QsyGenPrfTknFromPrfTkn
(unsigned char *<em>New_profile_token</em>,
unsigned char *<em>From_profile_token</em>,
int *<em>Time_out_interval</em>,
char *<em>New_profile_token_type</em>,
void *<em>Error_code</em>);
</pre>
&nbsp;&nbsp;Service Program: QSYPTKN<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p><img src="deltaend.gif" alt="End of change"></p>
<p>The Generate Profile Token From Profile Token (OPM, QSYGENFT; ILE,
QsyGenPrfTknFromPrfTkn) API generates a profile token using an existing profile
token. The existing profile token must be a valid, multiple-use, regenerable
profile token. The new profile token will represent the same user and group
information as the original profile token.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>API Public Authority</em></dt>
<dd>*USE</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Profile token</strong></dt>
<dd>OUTPUT; CHAR(32)
<p>The profile token that is generated.</p>
</dd>
<dt><strong>From profile token</strong></dt>
<dd>INPUT; CHAR(32)
<p>The multiple-use, regenerable profile token used to generate the new profile
token.</p>
</dd>
<dt><strong>Time out interval</strong></dt>
<dd>INPUT; BINARY(4)
<p>The time in seconds before the new profile token times out.</p>
<p>You can specify one of the following values:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top" nowrap><em>-1</em></td>
<td align="left" valign="top">Use system default value (3600 seconds)</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>1-3600</em></td>
<td align="left" valign="top">Time out value in second.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>New profile token type</strong></dt>
<dd>INPUT; CHAR(1)
<p>You can specify one of the following values:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Single-use profile token. A single-use profile
token can be used only on the Set To Profile Token (QSYSETPT;
QsySetToProfileToken) API once and cannot be used to generate new profile
tokens.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Multiple-use profile token. A multiple-use
profile token can be used on the Set To Profile Token (QSYSETPT;
QsySetToPrfTkn) API an unlimited number of times, but cannot be used to
generate new profile tokens.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Multiple-use, regenerable profile token. A
multiple-use, regenerable profile token can be used on the Set To Profile Token
(QSYSETPT; QsySetToPrfTkn) API an unlimited number of times and can be used to
generate a new single-use, multiple-use, or multiple-use, regenerable profile
token.</td>
</tr>
</table>
<br>
</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 cellpadding="5">
<!-- cols="15 85" -->
<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">CPF2225 E</td>
<td width="85%" valign="top">Not able to allocate internal system object.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2274 E</td>
<td align="left" valign="top">Profile token not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF229F E</td>
<td align="left" valign="top">Profile token not valid type.</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">CPF3C36 E</td>
<td align="left" valign="top">Number of parameters, &amp;1, entered for this
API was 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">CPF4AAA E</td>
<td align="left" valign="top">Maximum number of profile tokens have been
generated.</td>
</tr>
<tr>
<td align="left" valign="top">CPF4AAB E</td>
<td align="left" valign="top">Time out value not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF4AAD E</td>
<td align="left" valign="top">Profile token type not valid.</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: V4R5
<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>