System object attributes list

Following is a list of system object attributes. It includes descriptions, requirements, and considerations.

Also listed with each attribute are:

Note: The attributes' settings apply ONLY to the system object for which they are set, NOT to any other system objects, even if other system objects have the same iSeries™ system name.
iSeries system name:
The iSeries system with which to communicate and use by way of this instance of a system object. This can be set only at the time cwbCO_CreateSystem or cwbCO_CreateSystemLike is called. Note that the system name is used as the unique identifier when validating security information for a specific user ID: If two different system objects contain different system names that represent the same physical iSeries system, the user ID and password require separate validation for the two system objects. For example, this applies if the system names "SYS1" and "SYS1.ACME.COM" represent the same iSeries system. This may result in double prompting, and the use of different default user IDs when connecting.

Get by using cwbCO_GetSystemName

Default:
There is no default, since this is explicitly set when the system object is created.
Description
Description of the configured connection to the iSeries system.

Set using iSeries Navigator.

Retrieve using cwbCO_GetDescription

The description is stored with each system object, and never changed for that system object. If the description is changed using iSeries Navigator, system objects for that system that existed before the change was made are not changed. Only new system objects will contain the new description.

Default:
Blank. This may be overridden by policies.
User ID:
The user ID used to logon to the iSeries system.

Get by using cwbCO_GetUserIDEx

Set by using cwbCO_SetUserIDEx

Default:
The first time that you connect to the iSeries system which is named in the system object, you may be prompted:
  • To specify a default user ID
  • To specify that the default user ID should be the same as your Windows® user ID
  • That no default will be used
On subsequent connection attempts, the default user ID that is used will depend on which option you chose when prompted during the first connection attempt.
Password:
The password used to signon to the iSeries system.

Set by using cwbCO_SetPassword

Default:
Blank (no password set) if the user ID that is set in the system object never has signed on to the iSeries system that is named in the system object. If a previous successful signon or connection has been made to the iSeries system that is named in the system object, that password may be used for the next signon or connection attempt. The system will no longer cache a password in the iSeries Access for Windows volatile password cache if the password comes in through the cwbCO_SetPassword( ) API. Previously, this would have gone into the volatile (i.e. session) password cache.
Default user mode:
Controls behavior that is associated with the default user ID, including where to obtain it and whether to use it. If it is not set (if the value is CWBCO_DEFAULT_USER_MODE_NOT_SET), the user may be prompted to choose which behavior is desired at the time a signon is attempted.

Get by using cwbCO_GetDefaultUserMode

Set by using cwbCO_SetDefaultUserMode

Check for modify restriction by using cwbCO_CanModifyDefaultUserMode

Default:
CWBCO_DEFAULT_USER_MODE_NOT_SET
Note: The default may be overridden by policies.
Prompt mode:
Controls when iSeries Access for Windows will prompt the user for user ID and password. See the declaration comments for cwbCO_SetPromptMode for possible values and for associated behaviors.

Get by using cwbCO_GetPromptMode

Set by using cwbCO_SetPromptMode

Default:
CWBCO_PROMPT_IF_NECESSARY
Window handle:
The window handle of the calling application. If this is set, any prompting that iSeries Access for Windows does related to iSeries signon will use the window handle, and will be modal to the associated window. This means that the prompt never will be hidden UNDER the main application window if its handle is associated with the system object. If no window handle is set, the prompt might be hidden behind the main application window, if one exists.

Get by using cwbCO_GetWindowHandle

Set by using cwbCO_SetWindowHandle

Default:
NULL (not set)
Validate mode:
Specifies, when validating user ID and password, whether communication with the iSeries system to perform this validation actually occurs. See the declaration comments for cwbCO_SetValidateMode and cwbCO_GetValidateMode for possible values and for associated behaviors.

Get by using cwbCO_GetValidateMode

Set by using cwbCO_SetValidateMode

Default:
CWBCO_VALIDATE_IF_NECESSARY
Use Secure Sockets:
Specifies whether iSeries Access for Windows will use secure sockets to authenticate the server (iSeries system) and to encrypt data that is sent and received. There are some cases where secure sockets cannot be used (for example, when the software support for Secure Sockets has not been installed on the PC). Accordingly, an application or user request for secure sockets use may fail, either at the time the cwbCO_UseSecureSockets API is called, or at connect time. If no such failure occurs, then secure sockets is being used, and cwbCO_IsSecureSockets will return CWB_TRUE.

Get by using cwbCO_IsSecureSockets

Set by using cwbCO_UseSecureSockets

Check for modify restriction by using cwbCO_CanModifyUseSecureSockets

Default:
Whatever has been configured for this iSeries system in the System List will be used. If no configuration for this iSeries system exists, or if the configuration specifies to use the iSeries Access default, then secure sockets will not be used (CWB_FALSE).
Note: The default may be overridden by policies.
Port lookup mode:
Specifies how to retrieve the remote port for an iSeries host service. It specifies whether to look it up locally (on the PC), on the iSeries system, or to simply use the default ("standard") port for the specified service. If local lookup is selected, the standard TCP/IP method of lookup in the SERVICES file on the PC is used. If server lookup is specified, a connection to the iSeries system server mapper is made to retrieve the port number by lookup from the iSeries system service table. If either the local or server lookup method fails, then connecting to the service will fail. For more information and for possible values, see the API declaration for cwbCO_SetPortLookupMode.

Get by using cwbCO_GetPortLookupMode

Set by using cwbCO_SetPortLookupMode

Check for modify restriction by using cwbCO_CanModifyPortLookupMode

Default:
Whatever has been configured for this iSeries system in the System List will be used. If no configuration for this iSeries system exists, the default is CWBCO_PORT_LOOKUP_SERVER.
Note: The default may be overridden by policies.
Persistence mode:
Specifies whether the iSeries system named in this system object may be added to the System List (if not already in the list) once a successful call to cwbCO_Connect has completed. See cwbCO_SetPersistenceMode for more information and for possible values.

Get by using cwbCO_GetPersistenceMode

Set by using cwbCO_SetPersistenceMode

Check for modify restriction by using cwbCO_CanModifyPersistenceMode

Default:
CWBCO_MAY_MAKE_PERSISTENT
Note: The default may be overridden by policies.
Connect timeout
Specifies how long iSeries Access for Windows will wait for a connection attempt to complete. This setting does not affect how long the TCP/IP communications stack will wait before giving up. The TCP/IP communications stack might timeout before the iSeries Access connection timeout has expired. See cwbCO_SetConnectTimeout for more information and possible values. This value may be changed for a system object at any time.

get using cwbCO_GetConnectTimeout

set using cwbCO_SetConnectTimeout

Default:
CWBCO_CONNECT_TIMEOUT_DEFAULT
Note: The default may be overridden by policies.