cwbCO_HasSignedOn

Purpose

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).

Syntax

 
UINT CWB_ENTRY cwbCO_HasSignedOn(
                             cwbCO_SysHandle       system,
                             cwb_Boolean          *signedOn );

Parameters

cwbCO_SysHandle system - input: Handle that previously was returned from cwbCO_CreateSystem or cwbCO_CreateSystemLike. It identifies the iSeries™ system.
cwb_Boolean * signedOn - output: 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.)

Return Codes

The following list shows common return values:

CWB_OK: Successful completion.
CWB_INVALID_API_HANDLE: Invalid system handle.
CWB_INVALID_POINTER: The signedOn pointer is NULL.

Usage

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.