<?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_GetAdminCacheStateEx" />
<meta name="DC.Relation" scheme="URI" content="rzakxapis.htm" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rzakxcwbungetadmincachestateex" />
<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_GetAdminCacheStateEx</title>
</head>
<body id="rzakxcwbungetadmincachestateex"><a name="rzakxcwbungetadmincachestateex"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">cwbUN_GetAdminCacheStateEx</h1>
<div><p><strong>Purpose</strong></p>
<p>This API indicates whether the next invocation of the cwbUN_GetAdminValueEx
API will be long running. The cwbUN_GetAdminValueEx API caches data on the
PC. If the cache is not current, the cwbUN_GetAdminValueEx API may present
a sign-on prompt, or perform other processing, in order to update its cache.</p>
<p><strong>Syntax</strong></p>
<pre>CWBAPI unsigned int WINAPI cwbUN_GetAdminCacheStateEx(
cwbCO_SysHandle* pSysHandle,
cwbUN_State& adminState);</pre>
<p><strong>Parameters</strong></p>
<dl><dt class="dlterm">cwbCO_SysHandle* pSysHandle - input</dt>
<dd>A pointer to a system object handle. The system name must be specified
in the system object prior to calling this API.</dd>
<dt class="dlterm">cwbUN_State& adminState</dt>
<dd>Indicates if the next invocation of the cwbUN_GetAdminValue API will be
long running or if it will use its internal cache to return without accessing
the host iSeries™ server. <p>One
of three values will be returned:</p>
<dl><dt class="dlterm">cwbUN_logon</dt>
<dd>There is no current user for the specified iSeries server. The cwbUN_GetAdminValue
API may present a sign-on prompt.</dd>
<dt class="dlterm">cwbUN_refresh</dt>
<dd>cwbUN_GetAdminValue will access the iSeries server to update its internal
cache.</dd>
<dt class="dlterm">cwbUN_cache</dt>
<dd>cwbUN_GetAdminValue has a current cache and should not be long running.</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>
</dl>
<p><strong>Usage</strong></p>
<p>This API can be used by users of cwbUN_GetAdminValueEx to determine if
the next invocation of cwbUN_GetAdminValueEx will be long running.</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>