105 lines
5.9 KiB
HTML
105 lines
5.9 KiB
HTML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE html
|
||
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html lang="en-us" xml:lang="en-us">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 2005" />
|
||
|
|
<meta name="DC.rights.owner" content="(C) Copyright IBM Corporation 2005" />
|
||
|
|
<meta name="security" content="public" />
|
||
|
|
<meta name="Robots" content="index,follow" />
|
||
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
||
|
|
<meta name="DC.Type" content="concept" />
|
||
|
|
<meta name="DC.Title" content="cwbUN_GetAdminValueEx" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzakxapis.htm" />
|
||
|
|
<meta name="DC.Format" content="XHTML" />
|
||
|
|
<meta name="DC.Identifier" content="rzakxcwbungetadminvalueex" />
|
||
|
|
<meta name="DC.Language" content="en-us" />
|
||
|
|
<!-- 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. -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
||
|
|
<title>cwbUN_GetAdminValueEx</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzakxcwbungetadminvalueex"><a name="rzakxcwbungetadminvalueex"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">cwbUN_GetAdminValueEx</h1>
|
||
|
|
<div><p><strong>Purpose</strong></p>
|
||
|
|
<p>This API returns an indication of whether the current user on the specified iSeries™ server
|
||
|
|
is allowed or denied use of a specific administrable function. An <span class="uicontrol">Administrable
|
||
|
|
function</span> is any function whose use can be controlled through the
|
||
|
|
Application Administration subcomponent of iSeries Navigator.</p>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> iSeries Navigator
|
||
|
|
plug-ins should use the cwbUN_GetAdminValue API instead of cwbUN_GetAdminValueEx.</div>
|
||
|
|
<p>For example, the Application Administration subcomponent allows an administrator
|
||
|
|
to control whether a user can access several functions in iSeries Navigator.
|
||
|
|
One of these functions is 'Job Management'. The cwbUN_GetAdminValueEx API
|
||
|
|
can be used to programmatically determine if the current user can use the
|
||
|
|
Job Management function by specifying the name of the Administrable function
|
||
|
|
that corresponds to Job Management. See the CWBUNPLA.H header file for a list
|
||
|
|
of Administrable function names that are supported in iSeries Navigator.</p>
|
||
|
|
<p>This API provides the same function as cwbUN_GetAdminValue, except that
|
||
|
|
it is designed to accept a system object handle instead of a system name.</p>
|
||
|
|
<p><strong>Syntax</strong></p>
|
||
|
|
<pre>CWBAPI unsigned int WINAPI cwbUN_GetAdminValueEx(
|
||
|
|
cwbCO_SysHandle* pSysHandle,
|
||
|
|
char* adminFunction,
|
||
|
|
cwbUN_Usage& usageValue);</pre>
|
||
|
|
<p><strong>Parameters</strong></p>
|
||
|
|
<dl><dt class="dlterm">cwbCO_SysHandle* pSysHandle</dt>
|
||
|
|
<dd>A pointer to a system object handle. The system name must be specified
|
||
|
|
in the system object prior to calling this API. The cwbUN_GetAdminValueEx
|
||
|
|
API's behavior is based on whether the system object has obtained a signon
|
||
|
|
to the iSeries server: <dl><dt class="dlterm">Not Signed On-></dt>
|
||
|
|
<dd>cwbUN_GetAdminValueEx will signon to the iSeries server. The latest Application
|
||
|
|
Administration settings for the user will be downloaded from the iSeries server
|
||
|
|
if they are not already cached on the client PC.</dd>
|
||
|
|
<dt class="dlterm">Signed On-></dt>
|
||
|
|
<dd>If the system object was signed on to the iSeries server specifying that the iSeries userID
|
||
|
|
and password should be validated (Validate Mode), then the cwbUN_GetAdminValueEx
|
||
|
|
API will be using a snapshot of Application Administration settings that were
|
||
|
|
accurate at the time the signon was completed. If the signon was done without
|
||
|
|
validating the userID and password, then it is possible that cwbUN_GetAdminValueEx
|
||
|
|
will use a copy of the Application Administration settings that may be as
|
||
|
|
much as 24 hours old.</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">char* adminFunction</dt>
|
||
|
|
<dd>A pointer to an ASCII string that contains the name of the Administrable
|
||
|
|
function. The string must be null terminated and has a maximum length of 30
|
||
|
|
bytes + 1 byte for the NULL terminator. See CWBUNPLA.H for a list of supported
|
||
|
|
input values.</dd>
|
||
|
|
<dt class="dlterm">cwbUN_Usage& usageValue</dt>
|
||
|
|
<dd>This value is only valid if the return code of CWB_OK is returned. One
|
||
|
|
of two values will be returned: <dl><dt class="dlterm">cwbUN_granted</dt>
|
||
|
|
<dd>User is allowed use of the function.</dd>
|
||
|
|
<dt class="dlterm">cwbUN_denied</dt>
|
||
|
|
<dd>User is denied use of the function.</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<p><strong>Return Codes</strong></p>
|
||
|
|
<p>The following list shows common return values:</p>
|
||
|
|
<dl><dt class="dlterm">CWB_OK</dt>
|
||
|
|
<dd>The API was successful.</dd>
|
||
|
|
<dt class="dlterm">CWBSY_USER_CANCELLED</dt>
|
||
|
|
<dd>The user cancelled the user ID and password prompt presented by the API.</dd>
|
||
|
|
</dl>
|
||
|
|
<p><strong>Usage</strong></p>
|
||
|
|
<p>This API determines if the current iSeries user (as defined by the input
|
||
|
|
system object) is allowed to use the specified function. If no user is currently
|
||
|
|
signed on to the specified iSeries server, the API will sign the user on, possibly
|
||
|
|
displaying a user ID and password prompt.</p>
|
||
|
|
<p>This API can only be used to check Administrable functions that are in
|
||
|
|
the iSeries Navigator
|
||
|
|
or the Client Applications function category.</p>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzakxapis.htm" title="iSeries Navigator APIs help plug-in developers obtain and manage certain types of global information.">iSeries Navigator APIs</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|