ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaik_5.4.0.1/rzaikcwbcohassignedon.htm

78 lines
4.3 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<?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="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="reference" />
<meta name="DC.Title" content="cwbCO_HasSignedOn" />
<meta name="DC.Relation" scheme="URI" content="rzaikcommapilist3.htm" />
<meta name="copyright" content="(C) Copyright IBM Corporation 1999, 2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1999, 2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="cwbco_hassignedon" />
<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>cwbCO_HasSignedOn</title>
</head>
<body id="cwbco_hassignedon"><a name="cwbco_hassignedon"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbCO_HasSignedOn</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Returns an indication of whether the specified
system object has "signed on" (whether the user ID and password have been
validated at some point in the life of the specified system object). </p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
UINT CWB_ENTRY cwbCO_HasSignedOn(
cwbCO_SysHandle system,
cwb_Boolean *signedOn );</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbCO_SysHandle system - input</dt>
<dd>Handle that previously was returned from <span class="apiname">cwbCO_CreateSystem</span> or <span class="apiname">cwbCO_CreateSystemLike</span>.
It identifies the iSeries™ system.</dd>
<dt class="dlterm">cwb_Boolean * signedOn - output</dt>
<dd>A pointer to a cwb_Boolean into which is stored the indication of "signed-on-ness."
If the specified system object has signed on, it will be set to CWB_TRUE,
otherwise it will be set to CWB_FALSE. (On error it will be set to CWB_FALSE
as well.)</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Return Codes</h4><p>The following list shows common return
values:</p>
<dl><dt class="dlterm">CWB_OK</dt>
<dd>Successful completion.</dd>
<dt class="dlterm">CWB_INVALID_API_HANDLE</dt>
<dd>Invalid system handle.</dd>
<dt class="dlterm">CWB_INVALID_POINTER</dt>
<dd>The signedOn pointer is NULL.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>A returned indication of CWB_TRUE does not
mean that the user ID and password have been validated within a certain time
period, but only that since the system object's creation, a signon has occurred.
That signon may not have caused or included a connection and security validation
flow to the iSeries system.
This means that, even if CWB_TRUE is returned, the next call to the system
object that requires a successful signon might connect and attempt to re-validate
the user ID and password, and that validation, and hence the signon, may fail.
The signedOn indicator reflects the results of the most-recent user ID and
password validation. If user ID and password validation (signon) has occurred
successfully at one time, but since then this validation has failed, signedOn
will be set to CWB_FALSE.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikcommapilist3.htm" title="These APIs provide security validation and data.">Communication and security: Security validation and data APIs</a></div>
</div>
</div>
</body>
</html>