Properties quick reference table

Table 2-28 lists Client-Library properties. The context properties in this table are set through ct_config. For a list of context properties set through cs_config, see the reference page for cs_config in the Open Client and Open Server Common Libraries Reference Manual.

**Table 2-28: Client-Library properties**
Property name	Meaning	Possible values	Applicable level	Notes
CS_ANSI_BINDS	Whether or not to use ANSI-style binds. See “ANSI-style binds” for more information.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Context, connection.
CS_APPNAME	At the context level, the name the application calls itself. At the connection level, the application name used when logging into the server. See “Application name”.	A character string. The default is NULL.	Connection. To set at the context level, call cs_config.	Login property. At connection level, cannot be set after connection is established.
CS_ASYNC_ NOTIFS	Whether or not a connection receives registered procedure notifications asynchronously. See “Asynchronous notifications”.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Connection.	Must be set to CS_TRUE to receive notifications on an idle connection.
CS_BULK_LOGIN	Whether or not a connection is enabled to perform bulk-copy-in operations. See “Bulk copy operations”	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Connection.	Login property. Cannot be set after connection is established.
CS_CHARSETCNV	Whether or not character set conversion is taking place. See “Character set conversion”.	CS_TRUE or CS_FALSE. A default is not applicable.	Connection.	Retrieve only, after connection is established.
CS_COMMBLOCK	A pointer to a communication sessions block. This property is specific to IBM-370 systems and is ignored by all other platforms. See “Communications session block”.	A pointer value. The default is NULL.	Connection.	Cannot be set after connection is established.
CS_CON_ KEEPALIVE	Whether for use the KEEPALIVE option.	CS_TRUE or CS_FALSE. The default is CS_TRUE	Context or connection	Some Net-Library protocol drivers do not support this property. See “Checking whether a property is supported”.
CS_CON_STATUS	The connection’s status. See “Connection status”.	A CS_INT-sized bitmask.	Connection.	Retrieve only.
CS_CON_TCP_ NODELAY	Whether to use the TCP_NODELAY property.	CS_TRUE or CS_FALSE. The default is CS_TRUE.	Context or connection	Some Net-Library protocol drivers do not support this property. See “Checking whether a property is supported”.
CS_CONFIG_ BY_SERVERNAME	Whether ct_connect uses its server_name parameter or the value of the CS_APPNAME property as the section name to read external configuration data from. See “Using the runtime configuration file”.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Connection.	Meaningful only when external configuration has been enabled by setting CS_EXTERNAL_ CONFIG. Requires initialization with CS_VERSION_110or later.
CS_CONFIG_FILE	The name and location of the Open Client/ Server runtime configuration file. See “Using the runtime configuration file”.	A character string. The default is NULL, which means a platform-specific default is used.	Connection.	Meaningful only when external configuration has been enabled by setting CS_EXTERNAL_ CONFIG. Requires initialization with CS_VERSION_110or later.
CS_CUR_ID	The cursor’s identification number. See “Cursor ID”.	An integer value. A default is not applicable.	Command.	Retrieve only, after CS_CUR_ STATUS indicates an existing cursor.
CS_CUR_NAME	The cursor’s name, as defined in an application’s ct_cursor(CS_CURSOR_DECLARE) call. See “Cursor name”.	A character string. A default is not applicable.	Command.	Retrieve only, after ct_cursor (CS_CURSOR_ DECLARE) returns CS_SUCCEED.
CS_CUR_ ROWCOUNT	The current value of cursor rows. Cursor rows is the number of rows returned to Client-Library per internal fetch request. See “Cursor rowcount”.	An integer value. A default is not applicable.	Command.	Retrieve only, after CS_CUR_ STATUS indicates an existing cursor.
CS_CUR_STATUS	The cursor’s status. See “Cursor status”.	A CS_INT-sized value.	Command.	Retrieve only.
CS_DIAG_TIMEOUT	Whether Client-Library should fail or retry on timeout errors when inline error handling is in effect. See “Diagnostic timeout fail”.	CS_TRUE or CS_FALSE. The default is CS_FALSE, which means Client-Library should retry.	Connection.
CS_DISABLE_POLL	Whether or not to disable polling. If polling is disabled, ct_poll does not report asynchronous operation completions. See “Disable poll”.	CS_TRUE or CS_FALSE. The default is CS_FALSE, which means that polling is not disabled.	Context, connection.	Useful in layered asynchronous applications.
CS_DS_COPY	Whether the directory service is allowed to satisfy an application’s request with cached copies of directory entries. See “Directory service cache use”.	CS_TRUE or CS_FALSE. The default is CS_TRUE, which allows cache use.	Connection.	Not supported by all directory providers.
CS_DS_DITBASE	Fully qualified name of directory node where directory searches begin. See “Base for directory searches”.	A character string. The default is directory-provider specific.	Connection.	Not supported by all directory providers.
CS_DS_EXPAND ALIAS	Whether the directory service expands directory alias entries. See “Directory service expansion of aliases”.	CS_TRUE or CS_FALSE. The default is CS_TRUE, which allows alias expansion.	Connection.	Not supported by all directory providers.
CS_DS_FAILOVER	Whether to allow failover to the interfaces file when a directory service driver cannot be initialized. See “Directory service failover”.	CS_TRUE or CS_FALSE The default is CS_TRUE.	Connection.
CS_DS_PASSWORD	Password to go with the directory user ID specified as CS_DS_PRINCIPAL. See “Directory service password”.	A character string. The default is NULL.	Connection.	Not supported by all directory providers. The user name and password that are passed to the LDAP server for user authentication purposes are distinct and different from those used to access Adaptive Server.
CS_DS_PRINCIPAL	A directory user id for use of the directory service to go with the password specified as CS_DS_PASSWORD. See “Directory service principal name”.	A character string. The default is NULL.	Connection.	Not supported by all directory providers. The user name and password that are passed to the LDAP server for user authentication purposes are distinct and different from those used to access Adaptive Server.
CS_DS_PROVIDER	The name of the directory provider for the connection. See “Directory service provider”.	A character string. The default depends on directory driver configuration.	Connection.
CS_DS_SEARCH	Restricts the depth of a directory search. See “Directory service search depth”.	A CS_INT sized symbolic value. For a list of possible values, see “Directory service search depth”.	Connection.	Not supported by all directory providers.
CS_DS_SIZELIMIT	Restricts the number of directory entries that are returned by a search started with ct_ds_lookup. See “Directory search size limit”.	A CS_INT value greater than or equal to 0. The default is 0, which indicates there is no size limit.	Connection.	Not supported by all directory providers.
CS_DS_TIMELIMIT	Sets an absolute time limit, in seconds, for completion of directory searches begun with ct_ds_lookup. See “Directory search time limit”.	A CS_INT value greater than or equal to 0. The default is 0, which indicates there is no time limit.	Connection.	Not supported by all directory providers.
CS_EED_CMD	A pointer to a command structure containing extended error data. See “Extended error data command structure”.	A pointer value. A default is not applicable.	Connection.	Retrieve only.
CS_ENDPOINT	The file descriptor for a connection. See “Endpoint polling”.	An integer value. A default is not applicable. Value is -1 on platforms that do not support endpoint handles.	Connection.	Retrieve only, after connection is established.
CS_EXPOSE_FMTS	Whether to expose results of type CS_ROWFMT_ RESULT and CS_COM PUTEFMT_RESULT. See “Expose formats”.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Context, connection.	Cannot be set after connection is established.
CS_EXTERNAL_ CONFIG	Whether ct_init or ct_connect reads the Open Client/Server runtime configuration file to set properties and options for the connection to be opened. See “Using the runtime configuration file”.	CS_TRUE or CS_FALSE. The default is inherited from the CS-Library context property of the same name.	Context, connection.	Requires initialization with CS_VERSION_110 or later.
CS_EXTRA_INF	Whether to return the extra information that’s required when processing Client-Library messages inline using a SQLCA, SQLCODE, or SQLSTATE. See “Extra information”.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Context, connection.
CS_HAFAILOVER	See “High-availability failover”.	CS_TRUE or CS_FALSE.	Context, connection.	Requires initialization with CS_VERSION_120 or later.
CS_HAVE_BINDS	Whether any saved result bindings are present for the current result set. See “Have bindings”.	CS_TRUE or CS_FALSE. A default is not applicable.	Command.	Retrieve only.
CS_HAVE_CMD	Whether a resendable command exists for the command structure. See “Have resendable command”.	CS_TRUE or CS_FALSE.	Command.	Retrieve only.
CS_HAVE_CUROPEN	Whether a restorable cursor-open command exists for the command structure. See “Have restorable cursor-open command”.	CS_TRUE or CS_FALSE.	Command.	Retrieve only.
CS_HIDDEN_KEYS	Whether to expose hidden keys. See “Hidden keys”.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Context, connection, command.	Cannot be set at the command level if results are pending or a cursor is open.
CS_HOSTNAME	The host machine name. See “Host name”.	A character string. The default is NULL.	Connection.	Login property. Cannot be set after connection is established.
CS_IFILE	The path and name of the interfaces file. See “Location of the interfaces file”.	A character string.	Context.
CS_LOC_PROP	A CS_LOCALE structure that defines localization information. See “Locale information”.	A CS_LOCALE structure. A connection picks up default localization information from its parent context.	Connection. To set CS_LOC_ PROP at the context level, call cs_config.	Login property. Cannot be set after connection is established.
CS_LOGIN_STATUS	Whether the connection is open. See “Login status”.	CS_TRUE or CS_FALSE. A default is not applicable.	Connection.	Retrieve only.
CS_LOGIN_ TIMEOUT	The login timeout value. See “Login timeout”.	An integer value. The default is 60 seconds. A value of CS_NO_LIMIT represents an infinite timeout period.	Context.
CS_LOOP_DELAY	The delay, in seconds, that ct_connect waits before retrying the sequence of addresses associated with a server name. See “Loop delay”.	A CS_INT >= 0. The default is 0.	Connection.	CS_RETRY_ COUNT specifies the number of times to retry.
CS_MAX_CONNECT	The maximum number of connections for this context. See “Maximum number of connections”.	An integer value. The default is 25.	Context.
CS_MEM_POOL	A memory pool that Client-Library will use to satisfy interrupt-level memory requirements. See “Memory pool”.	A pointer value. The default is NULL (no user-supplied memory pool).	Context.	Useful in asynchronous applications. Cannot be set or cleared when context has connections.
CS_NETIO	Whether network I/O is synchronous, fully asynchronous, or deferred-asynchronous. See “Network I/O”.	CS_SYNC_IO, CS_ASYNC_IO, or CS_DEFER_IO. The default is CS_SYNC_IO.	Context, connection.	Cannot be set for a context with open connections. CS_DEFER_IO is legal only at the context level. CS_ASYNC_IO cannot be used in an Open Server gateway.
CS_NO_TRUNCATE	Whether Client-Library should truncate or sequence messages that are longer than CS_MAX_MSG. See “No truncate”.	CS_TRUE or CS_FALSE. The default is CS_FALSE, which means that Client-Library truncates long messages.	Context.
CS_NOAPI_CHK	Whether Client-Library performs argument and state checking when the application calls a Client-Library routine. See “No API checking”.	CS_TRUE or CS_FALSE. The default is CS_FALSE, which means that Client-Library performs API checking.	Context.
CS_NOCHARSETCN_ REQD	Whether the server performs character set conversion if the server’s character set is different from the client’s. See “No character conversion required”.	CS_TRUE or CS_FALSE. The default is CS_FALSE, which means conversion occurs when necessary.	Connection.	Cannot be set after connection is established.
CS_NOINTERRUPT	Whether the application can be interrupted by certain callback events. See “No interrupt”.	CS_TRUE or CS_FALSE. The default is CS_FALSE, which means the application can be interrupted.	Context.
CS_NOTIF_CMD	A pointer to a command structure containing registered procedure notification parameters.	A pointer value. A default is not applicable.	Connection.	Retrieve only.
CS_PACKETSIZE	The TDS packet size in bytes. See “Packet size”.	An integer value. The default varies by platform. On most platforms, the default is 512.	Connection.	Negotiated login property. Cannot be set after connection is established.
CS_PARENT_HANDLE	The address of a command or connection structure’s parent structure. See “Parent structure”.	A pointer value.	Connection, command.	Retrieve only.
CS_PASSWORD	The password used to log in to the server. See “Password”.	A character string. The default is NULL.	Connection.	Login property.
CS_PROP_SSL_ PROTOVERSION	The version of supported SSL/TLS protocols.	CS_INT	Context, connection	Must be one of the following values. CS_SSLVER_20 CS_SSLVER_30 CS_SSLVER_TLS1
CS_PROP_SSL_ CIPHER	Comma-separated list of CipherSuite names.	CS_CHAR	Context, connection
CS_PROP_SSL_ LOCALID	Property used to specify the path to the Local ID (certificates) file.	Character string	Context connection	A structure containing a file name and a password used to decrypt the information in the file.
CS_PROP_SSL_CA	Specify the path to the file containing trusted CA certificates.	CS_CHAR	Context, connection
CS_RETRY_COUNT	The number of times to retry a connection to a server’s address. See “Retry count”.	A CS_INT >= 0. The default is 0.	Connection.	Affects only the establishment of a login dialog. Failed logins are not retried.
CS_SEC_ APPDEFINED	Whether the connection will use application-defined challenge/response security handshaking. See “Security handshaking: Challenge/Response”.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Connection.	Cannot be set after connection is established.
CS_SEC_CHALLENGE	Whether the connection will use Sybase-defined challenge/response security handshaking. See “Security handshaking: Challenge/Response”.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Connection.	Cannot be set after connection is established.
CS_SEC_CHANBIND	Whether the connection’s security mechanism will perform channel binding. See “Requesting login authentication services”.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Context, connection.	Cannot be set after connection is established. Requires a supporting network security mechanism.
CS_SEC_ CONFIDENTIALITY	Whether data encryption service will be performed on the connection. See “Requesting per-packet security services”.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Context, connection.	Cannot be set after connection is established. Requires a supporting network security mechanism.
CS_SEC_ CREDENTIALS	Used by gateway applications to forward a delegated user credential. See “Requesting login authentication services”.	A CS_VOID * pointer.	Context, connection.	Cannot be read. Cannot be set after connection is established. Requires a supporting network security mechanism.
CS_SEC_ CREDTIMEOUT	Whether the user’s credentials have expired. See “Requesting login authentication services”.	A CS_INT. See Table 2-31 for possible values and their meanings.	Context, connection.	Cannot be set after connection is established. Requires a supporting network security mechanism.
CS_SEC_ DATAORIGIN	Whether the connection’s security mechanism will perform data origin verification. See “Requesting per-packet security services”.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Context, connection.	Cannot be set after connection is established. Requires a supporting network security mechanism.
CS_SEC_ DELEGATION	Whether to allow the server to connect to a second server with the user’s delegated credentials. See “Requesting login authentication services”.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Context, connection.	Cannot be set after connection is established. Requires a supporting network security mechanism.
CS_SEC_ DETECTREPLAY	Whether the connection’s security mechanism will detect replayed transmissions. See “Requesting per-packet security services”.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Context, connection.	Cannot be set after connection is established. Requires a supporting network security mechanism.
CS_SEC_ DETECTSEQ	Whether the connection’s security mechanism will detect transmissions that arrive out of sequence. See “Requesting per-packet security services”.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Context, connection.	Cannot be set after connection is established. Requires a supporting network security mechanism.
CS_SEC_ ENCRYPTION	Whether the connection will use encrypted password security handshaking. See “Security handshaking: encrypted password”.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Connection.	Cannot be set after connection is established.
CS_SEC_INTEGRITY	Whether the connection’s security mechanism will perform data integrity checking. See “Requesting per-packet security services”.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Context, connection.	Cannot be set after connection is established. Requires a supporting network security mechanism.
CS_SEC_KEYTAB	The name and path to the file from which a connection’s security mechanism reads the security key to go with the CS_USERNAME property. See “Requesting login authentication services”.	A character string. The default is NULL, which means the user must have established credentials before the application calls ct_connect.	Connection.	Cannot be set after connection is established. Requires a supporting network security mechanism.
CS_SEC_ MECHANISM	The name of the network security mechanism that performs security services for the connection. See “Choosing a network security mechanism”.	A string value. The default depends on security driver configuration.	Context, connection.	Cannot be set after connection is established.
CS_SEC_ MUTUALAUTH	Whether the server is required to authenticate itself to the client. See “Requesting login authentication services”.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Context, connection.	Cannot be set after connection is established. Requires a supporting network security mechanism.
CS_SEC_NEGOTIATE	Whether or not the connection will use trusted-user security handshaking to pass security labels to the server.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Connection.	Cannot be set after connection is established.
CS_SEC_ NETWORKAUTH	Whether the connection’s security mechanism will perform network-based user authentication. See “Requesting login authentication services”.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Context, connection.	Cannot be set after connection is established. Requires a supporting network security mechanism and a preestablished credential that matches CS_USERNAME.
CS_SEC_ SERVERPRINCIPAL	The network security principal name for the server to which a connection will be opened. See “Requesting login authentication services”.	A string value. The default is NULL, which means that ct_connect assumes the server principal name is the same as its server_name parameter.	Connection.	Cannot be set after connection is established. Meaningful only for connections that use network-based user authentication.
CS_SEC_ SESSTIMEOUT	Whether the connection’s security session has expired. See “Requesting login authentication services”.	A CS_INT. See Table 2-31 for possible values and their meanings.	Context, connection.	Cannot be set after connection is established. Requires a supporting network security mechanism.
CS_SERVERADDR	The address of the server to which you are connected to.	The format “hostname portnumber [filter], where filter is optional.	Connection	Using this property causes ctlib to bypass the host name of the server and the port number of the interfaces.
CS_SERVERNAME	The name of the server to which you are connected. See “Server name”.	A string value. A default is not applicable.	Connection.	Retrieve only, after connection is established.
CS_STICKY_BINDS	Whether or not bindings between result items and program variables persist when a server command is executed repeatedly. See “Persistent result bindings”.	CS_TRUE or CS_FALSE. The default is CS_FALSE.	Command.
CS_TDS_VERSION	The version of the TDS protocol that the connection is using. See “TDS version”.	A symbolic version level. Defaults to a value based on CS_VERSION.	Connection.	Negotiated login property. Cannot be set after connection is established.
CS_TEXTLIMIT	The largest text or image value to be returned on this connection. See “Text and image limit”.	An integer value. The default is CS_NO_LIMIT.	Context, connection.
CS_TIMEOUT	The timeout value for reading results from the server. See “Timeout”.	An integer value. The default is CS_NO_LIMIT.	Context.
CS_TRANSACTION_ NAME	A transaction name to be used over a connection to Open Server for CICS. See “Transaction name”.	A string value. The default is NULL.	Connection.
CS_USER_ALLOC	A user-defined memory allocation routine. See “User allocation function”.	A pointer to a user-defined function. A default is not applicable.	Context.	Useful in asynchronous application.
CS_USER_FREE	A user-defined memory free routine. See “User free function”.	A pointer to a user-defined function. A default is not applicable.	Context.	Useful in asynchronous application.
CS_USERDATA	User-allocated data. See “User data”.	User-allocated data.	Connection, command. To set CS_USER DATA at the context level, call cs_config.
CS_USERNAME	The name used to log in to the server. See “User name”.	A character string. The default is NULL.	Connection.	Login property. Cannot be set after connection is established.
CS_VER_STRING	Client-Library’s true version string. See “Version string for Client-Library”.	A character string. A default is not applicable.	Context.	Retrieve only.
CS_VERSION	The version of Client-Library in use by this context. See “Version of Client-Library”.	A symbolic version level. CS_VERSION gets its value from a context’s ct_init call. See the detailed description for possible values.	Context.	Retrieve only.