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

397 lines
9.9 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>Change Function Usage Information (QSYCHFUI, QsyChangeFunctionUsageInfo)
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>Change Function Usage Information (QSYCHFUI, QsyChangeFunctionUsageInfo)
API</h2>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;<img src="delta.gif" alt="Start of change">Required Parameter Group for QSYCHFUI:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Function ID</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(30)</td>
</tr>
<tr>
<td align="center" valign="top">2</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">3</td>
<td align="left" valign="top">Function usage information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Length of function usage information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</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 QsyChangeFunctionUsageInfo:<br>
<pre>
#include &lt;qsyfnusg.h&gt;
void QsyChangeFunctionUsageInfo
(char <em>Function_ID</em>[30],
char <em>Format_name</em>[8],
void *<em>Function_usage_information</em>
int *<em>Length_of_function_usage_information</em>,
void *<em>Error_code</em>);
</pre>
&nbsp;&nbsp;Service Program: QSYFNUSG<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<img src="deltaend.gif" alt="End of change"><br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Change Function Usage Information (OPM, QSYCHFUI; ILE,
QsyChangeFunctionUsageInfo) API changes the usage information for a function.
The usage information for a function indicates which user profiles are allowed
or not allowed to use a function.</p>
<p>The usage information is stored with the user profile. To save and restore
the usage information, you must use the same methods as with other user profile
information (Save Security Data (SAVSECDTA) command, Restore User Profiles
(RSTUSRPRF) command, Restore Authority (RSTAUT) command).</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>API Public Authority</em></dt>
<dd>*USE</dd>
<dt><em>Authority Required</em></dt>
<dd>*SECADM special authority</dd>
<dt><em>Usage Information Lock</em></dt>
<dd>*EXCL</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Function ID</strong></dt>
<dd>INPUT; CHAR(30)
<p>The ID of the function for which usage information is being changed.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the function usage information.</p>
<p>The valid value is:</p>
<table cellpadding="5">
<!-- cols="30 70" -->
<tr>
<td valign="top"><em><a href="#HDRCFUI100">CFUI0100</a></em></td>
<td valign="top">Function usage information</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Function usage information</strong></dt>
<dd>INPUT; CHAR(*)
<p>The usage information that is being changed for the specified function. See
<a href="#HDRCFUI100">CFUI0100 Format</a> for the definition of the fields for
this parameter.</p>
</dd>
<dt><strong>Length of function usage information</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the function usage information. This area must be as large as
the format specified.</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><a name="HDRCFUI100">CFUI0100 Format</a></h3>
<p>The following table shows the information that must be specified in the
function usage information parameter when format CFUI0100 is specified. For a
detailed description of each field, see <a href="#HDRFLDDCS3">Field
Descriptions</a>.</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%">Number of usage information
entries</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4">Usage information entry. These fields
are repeated for each usage information entry returned.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User profile name</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Usage setting</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRFLDDCS3">Field Descriptions</a></h3>
<p><strong>Number of usage information entries.</strong> The total number of
usage information entries. This value must be greater than 0.</p>
<p><strong>Usage information entries.</strong> The entries that contain the
usage information.</p>
<p><strong>Usage setting.</strong> Whether the user is allowed to use the
function or not.</p>
<p>The following values can be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">The user's previous setting is removed.</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">The user is not allowed to use the function.</td>
</tr>
<tr>
<td valign="top"><em>2</em></td>
<td valign="top">The user is allowed to use the function.</td>
</tr>
</table>
<p><strong>User profile name.</strong> The name of the user profile whose usage
setting is being changed. The user profile must exist.</p>
<br>
<h3>Error Messages</h3>
<table width="100%" 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 valign="top">CPF222E E</td>
<td valign="top">&amp;1 special authority is required.</td>
</tr>
<tr>
<td valign="top">CPF228A E</td>
<td valign="top">Function &amp;1 not registered.</td>
</tr>
<tr>
<td valign="top">CPF229B E</td>
<td valign="top">Operation not allowed for function &amp;1.</td>
</tr>
<tr>
<td valign="top">CPF229C E</td>
<td valign="top">Not all usage information changed for function &amp;1.</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">CPF3C3C E</td>
<td valign="top">Value for parameter &amp;1 not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C36 E</td>
<td valign="top">Number of parameters, &amp;1, entered for this API was not
valid.</td>
</tr>
<tr>
<td valign="top">CPF3CD9 E</td>
<td valign="top">Requested function cannot be performed at this time.</td>
</tr>
<tr>
<td valign="top">CPF3CDA E</td>
<td valign="top">Registration facility repository not available for use.</td>
</tr>
<tr>
<td valign="top">CPF3CF1 E</td>
<td valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td valign="top">CPF3CF2 E</td>
<td valign="top">Error(s) occurred during running of &amp;1 API.</td>
</tr>
<tr>
<td valign="top">CPF3C90 E</td>
<td valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td valign="top">CPF8100 E</td>
<td valign="top">All CPF81xx messages could be returned. xx is from 01 to
FF.</td>
</tr>
<tr>
<td valign="top">CPF9810 E</td>
<td valign="top">Library &amp;1 not found.</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>
</table>
<br>
<hr>
API introduced: V4R3
<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>