FreeTDS User Guide: A Guide to Installing, Configuring, and Running FreeTDS
Prev | Chapter 10. Programming | Next

# ct-lib API Implementation Summary

Sybase ct-lib documentation can be found online and in PDF form. [1]

Table 10-2. ct-lib API Implementation Summary

Category | Function | Status | Comments
--- | --- | --- | ---
(all) | ct_bind | OK | Bind server results to program variables.
(all) | ct_br_column |  | Retrieve information about a column generated by a browse mode select.
(all) | ct_br_table |  | Return information about browse mode tables.
(all) | ct_callback | OK | Install or retrieve a Client-Library callback routine.
(all) | ct_cancel | OK | Cancel a command or the results of a command.
(all) | ct_capability | OK | Set or retrieve a client/server capability.
(all) | ct_close | OK | Close a server connection.
(all) | ct_cmd_alloc | OK | Allocate a CS_COMMAND structure.
(all) | ct_cmd_drop | OK | Deallocate a CS_COMMAND structure.
(all) | ct_cmd_props | OK | Set or retrieve command structure properties. For use by applications that resend commands.
(all) | ct_command | OK | Initiate a language, package, RPC, message, or send-data command.
(all) | ct_compute_info | OK | Retrieve compute result information.
(all) | ct_con_alloc | OK | Allocate a CS_CONNECTION structure.
(all) | ct_con_drop | OK | Deallocate a CS_CONNECTION structure.
(all) | ct_con_props | OK | Set or retrieve connection structure properties.
(all) | ct_config | OK | Set or retrieve context properties.
(all) | ct_connect | OK | Connect to a server.
(all) | ct_cursor OK | Initiate a Client-Library cursor command. |
(all) | ct_data_info | OK | Define or retrieve a data I/O descriptor structure.
(all) | ct_debug |  | Manage debug library operations.
(all) | ct_describe | OK | Return a description of result data.
(all) | ct_diag | OK | Manage inline error handling.
(all) | ct_ds_dropobj |  | Release the memory associated with a directory object.
(all) | ct_ds_lookup |  | Initiate or cancel a directory lookup operation.
(all) | ct_ds_objinfo |  | Retrieve information associated with a directory object.
(all) | ct_dynamic | OK | Initiate a dynamic SQL command.
(all) | ct_dyndesc |  | Perform operations on a dynamic SQL descriptor area.
(all) | ct_dynsqlda |  | Operate on a SQLDA structure.
(all) | ct_exit | OK | Exit Client-Library.
(all) | ct_fetch | OK | Fetch result data.
(all) | ct_get_data | OK | Read a chunk of data from the server.
(all) | ct_getformat |  | Return the server user-defined format string associated with a result column.
(all) | ct_getloginfo |  | Transfer TDS login response information from a CS_CONNECTION structure to a newly allocated CS_LOGINFO structure.
(all) | ct_init | OK | Initialize Client-Library for an application context.
(all) | ct_keydata |  | Specify or extract the contents of a key column.
(all) | ct_labels |  | Define a security label or clear security labels for a connection.
(all) | ct_options | OK | Set, retrieve, or clear the values of server query-processing options.
(all) | ct_param | OK | Supply values for a server command's input parameters.
(all) | ct_poll | stub | Poll connections for asynchronous operation completions and registered procedure notifications.
(all) | ct_recvpassthru |  | Receive a TDS (Tabular Data Stream) packet from a server.
(all) | ct_remote_pwd |  | Define or clear passwords to be used for server-to-server connections.
(all) | ct_res_info | OK | Retrieve current result set or command information.
(all) | ct_results | OK | Set up result data to be processed.
(all) | ct_send | OK | Send a command to the server.
(all) | ct_send_data | OK | Send a chunk of text or image data to the server.
(all) | ct_sendpassthru |  | Send a Tabular Data Stream (TDS) packet to a server.
(all) | ct_setloginfo |  | Transfer TDS login response information from a CS_LOGINFO structure to a CS_CONNECTION structure.
(all) | ct_setparam | OK | Specify source variables from which ct_send reads input parameter values for a server command.
(all) | ct_wakeup |  | Call a connection's completion callback.
(all) | cs_calc |  | Perform an arithmetic operation on two operands.
(all) | cs_cmp |  | Compare two data values.
(all) | cs_config | partial | Set or retrieve CS-Library properties.
(all) | cs_conv_mult | stub | Retrieve the conversion multiplier for converting character data from one character set to another.
(all) | cs_convert | OK | Convert a data value from one datatype, locale, or format to another datatype, locale, or format.
(all) | cs_ctx_alloc | OK | Allocate a CS_CONTEXT structure.
(all) | cs_ctx_drop | OK | Deallocate a CS_CONTEXT structure.
(all) | cs_ctx_global | OK | Allocate or return a CS_CONTEXT structure.
(all) | cs_diag | OK | Manage inline error handling.
(all) | cs_dt_crack | OK | Convert a machine-readable datetime value into a user-accessible format.
(all) | cs_dt_info | OK | Set or retrieve language-specific datetime information.
(all) | cs_loc_alloc | stub | Allocate a CS_LOCALE structure.
(all) | cs_loc_drop | stub | Deallocate a CS_LOCALE structure.
(all) | cs_locale | stub | Load a CS_LOCALE structure with localization values or retrieve the locale name previously used to load a CS_LOCALE structure.
(all) | cs_manage_convert | stub | Install or retrieve a user-defined character set conversion routine.
(all) | cs_objects | stub | Save, retrieve, or clear objects and data associated with them.
(all) | cs_set_convert | stub | Install or retrieve a user-defined conversion routine.
(all) | cs_setnull | stub | Define a null substitution value to be used when binding or converting NULL data.
(all) | cs_strbuild | OK | Construct native language message strings.
(all) | cs_strcmp | stub | Compare two strings using a specified sort order.
(all) | cs_time | stub | Retrieve the current date and time.
(all) | cs_will_convert | OK | Indicate whether a specific datatype conversion is available in the Client/Server libraries.
(all) | blk_alloc | OK | Allocate a CS_BLKDESC structure.
(all) | blk_bind | OK | Bind a program variable and a database column.
(all) | blk_colval | stub | Server-side routine to obtain the column value from a formatted bulk copy row.
(all) | blk_default | stub | Retrieve a column's default value.
(all) | blk_describe | OK | Retrieve a description of a database column.
(all) | blk_done | OK | Mark a complete bulk copy operation or a complete bulk copy batch.
(all) | blk_drop | OK | Deallocate a CS_BLKDESC structure.
(all) | blk_getrow | stub | Server-side routine to retrieve and store a formatted bulk copy row.
(all) | blk_gettext | stub | Server-side routine to retrieve the text, image, sensitivity, or boundary portion of an incoming bulk copy formatted row.
(all) | blk_init | OK | Initiate a bulk copy operation.
(all) | blk_props | OK | Set or retrieve bulk descriptor structure properties.
(all) | blk_rowalloc | stub | Server-side routine to allocate space for a formatted bulk copy row.
(all) | blk_rowdrop | stub | Server-side routine to free space previously allocated for a formatted bulk copy row.
(all) | blk_rowxfer | OK | Transfer one or more rows during a bulk copy operation without specifying or receiving a row count.
(all) | blk_rowxfer_mult | OK | Transfer one or more rows during a bulk copy operation.
(all) | blk_sendrow | stub | Server-side routine to send a formatted bulk copy row obtained from blk_getrow.
(all) | blk_sendtext | stub | Server-side routine to send text, image, sensitivity, or boundary data in a formatted bulk copy row obtained from blk_sendtext.
(all) | blk_srvinit | stub | Server-side routine to copy descriptions of server table columns to the client, if required.
(all) | blk_textxfer | stub | Transfer a column's data in chunks during a bulk copy operation.

### Notes

[1] | Links such as these are quite perishable. Should you find them broken, please check the FreeTDS User Guide posted on our website. If it's out of date, please let us know, so we can correct it. Thanks.

Prev | Home | Next
db-lib API Implementation Summary | Up | ODBC API Implementation Summary