cwbCO_GetConnectTimeout

Purpose

This function gets, for the specified system object, the connection timeout value, in seconds, currently set.

Syntax

 
UINT CWB_ENTRY cwbCO_GetConnectTimeout(
                             cwbCO_SysHandle              system,
                             PULONG                       timeout );

Parameters

cwbCO_SysHandle system - input

Handle returned previously from cwbCO_CreateSystem or cwbCO_CreateSystemLike. It identifies the iSeries™ system.

PULONG timeout - output

Returns the timeout value, in seconds. This value will be from CWBCO_CONNECT_TIMEOUT_MIN to CWBCO_CONNECT_TIMEOUT_MAX, or will be CWBCO_CONNECT_TIMEOUT_NONE if no connection timeout is desired.

Return Codes

The following list shows common return values.

CWB_OK

Successful completion.

CWB_INVALID_API_HANDLE

Invalid system handle.

CWB_INVALID_POINTER

The timeout pointer is NULL.

Usage

None.