Purpose
This function sets for the specified system
object if the system it represents (as named in the system object), along
with its attributes, may be added to the System List (if not already in the
list) once a signon successfully has occurred.
Syntax
UINT CWB_ENTRY cwbCO_SetPersistenceMode(
cwbCO_SysHandle system,
cwbCO_PersistenceMode mode );
Parameters
- cwbCO_SysHandle system - input
- Handle returned previously from cwbCO_CreateSystem or cwbCO_CreateSystemLike.
It identifies the iSeries™ system.
- cwbCO_PersistenceMode mode - input
- Specifies the persistence mode. Possible values are:
- CWBCO_MAY_MAKE_PERSISTENT
- If the system that is named in the specified system object is not yet
in the System List, add it to the list once a successful signon has completed.
This will make the system, as defined by this system object, available for
selection by this AND other applications running, now or in the future, on
this personal computer (until the system is deleted from this list).
- CWBCO_MAY_NOT_MAKE_PERSISTENT
- The system that is named in the specified system object (along with its
attributes) may NOT be added to the System List.
Return Codes
The following list shows common return
values.
- CWB_OK
- Successful completion.
- CWB_INVALID_API_HANDLE
- Invalid system handle.
- CWB_INVALID_PARAMETER
- The mode parameter is an invalid value.
- CWB_RESTRICTED_BY_POLICY
- A policy exists that prohibits the user from changing this value.
- CWB_INV_AFTER_SIGNON
- Signon successfully has occurred by using the specified system object,
so this setting no longer may be changed.
Usage
This API cannot be used after a successful
signon has occurred for the specified system object. A signon has occurred
if either cwbCO_Signon or cwbCO_Connect has
been called successfully for this system object.
If the system as named
in the system object already is in the System List, this setting has no effect.