CS_APPNAME defines the application name that a connection uses when connecting to a server.
CS_CHARSETCNV indicates whether or not the server is converting between the client and server character sets. This property is retrieve-only, after a connection is established.
A value of CS_TRUE indicates that the server is converting between the client and server character sets; CS_FALSE indicates that no conversion is taking place.
CS_COMMBLOCK defines a pointer to a communications block (EIB).
CS_EXTRA_INF determines whether or not Open ClientConnect returns the extra information that CTBDIAG requires to fill in SQLCA or SQLCODE structures.
This extra information includes the number of rows affected by the most recent command.
If an application is not retrieving messages into a SQLCA or SQLCODE, the extra information is returned as ordinary Client-Library messages.
CS_HOSTNAME is the name of the host machine, used when logging in to a server.
CS_LOC_PROP defines a pointer to a CS_LOCALE structure, which contains localization information. Localization information includes a language, a character set, datetime, money, and numeric formats, and a collating sequence. This property must be set to 0.
CS_LOGIN_STATUS is CS_TRUE if a connection is open, CS_FALSE if it is not. This property can only be retrieved.
CTBCONNECT is used to open a connection.
CS_LOGIN_TIMEOUT defines the length of time, in seconds, that an application waits for a login response when making a connection attempt. Timeouts are not supported under CICS.
CS_MAX_CONNECT defines the maximum number of simultaneously open connections that a context can have. The default varies by platform. Negative and zero values are not allowed for CS_MAX_CONNECT.
On mainframes, CS_MAX_CONNECT has a default value of 25 (an unlimited number of connections can be defined for a context).
If CTBCONFIG is called to set a value for CS_MAX_CONNECT that is less than the number of currently open connections, CTBCONFIG generates an error and returns CS_FAIL without altering the value of CS_MAX_CONNECT.
CS_NET_DRIVER determines the type of dynamic network driver that is used. Possible values are:
CS_INTERLINK
CS_LU62
CS_NCPIC
CS_TCPIP
The default value for CICS and IMS is CS_LU62. The default value for MVS is CS_NCPIC.
CS_NETIO determines whether a connection is synchronous or asynchronous.
Because Open ClientConnect does not support asynchronous processing, this value is always CS_SYNC_IO.
CS_NOINTERRUPT is not supported for Open ClientConnect. It is included for compatibility with other Open Client libraries.
CS_PACKETSIZE determines the packet size that Open ClientConnect uses when sending Tabular Data Stream (TDS) packets.
If an application needs to send or receive large amounts of text, image, or bulk data, a larger packet size can improve efficiency. The default packet size is 512.
CS_PASSWORD defines the password that a connection uses when logging in to a server.
CS_TDS_VERSION defines the version of the Tabular Data Stream (TDS) protocol that the connection is using.
Because CS_TDS_VERSION is a negotiated login property, its value can change during the login process. An application can set CS_TDS_VERSION to request a TDS level before calling CTBCONNECT. In this case, when CTBCONNECT creates the connection, it looks for the requested TDS version. If the server cannot provide the requested TDS version, a new (lower) TDS version is negotiated. An application can retrieve the value of CS_TDS_VERSION after a connection is established to determine the actual version of TDS in use.
The following table lists the symbolic values that CS_TDS_VERSION can have:
Value |
Indicates |
Features supported |
|---|---|---|
CS_TDS_46 |
4.6 TDS |
Registered procedures, TDS passthrough, negotiable TDS packet size, multibyte character sets. |
CS_TDS_50 |
5.0 TDS |
Accesses system Adaptive Server 10.0 and above.
|
CS_TEXTLIMIT indicates the length, in bytes, of the longest text or image value that an application wants to receive. Open ClientConnect reads but ignores any part of a text or image value that goes over this limit.
The default value of CS_TEXTLIMIT is CS_NO_LIMIT, meaning the application reads and returns all data sent by the server.
CS_TIMEOUT controls the length of time, in seconds, that Client-Library waits for a server response when making a request.
This value is ignored by Open ClientConnect.
CS_TRANSACTION_NAME names a transaction. If the accessed server is a Gateway-Library application, this is the name of the transaction.
Calls to Adaptive Server do not require a transaction name.
All Client-Library applications can set CS_TRANSACTION_NAME. If a transaction name is not required, CS_TRANSACTION_NAME is ignored.
CS_USERDATA property defines user-allocated data. This property allows an application to associate user data with a particular connection or command structure. An application allocates a data space from which it can get this data when needed.
To associate user data with a context structure, an application calls CSBCONFIG.
A PL/I program can use the Working Storage section to define this data.
CS_USERNAME defines the user login name that the connection uses to log into a server.
CS_VERSION represents the version of Open ClientConnect behavior that an application requests through CTBINIT. The value of this property can only be retrieved.
Connections allocated within a context pick up default CS_TDS_VERSION values from their parent context CS_VERSION level.
TDS
5.0 only works with an Adaptive Server 10.0 and above.