JezK
Edit File: ctlib.api.summary.html
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>ct-lib API Implementation Summary</title><link rel="stylesheet" type="text/css" href="userguide.css" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="home" href="index.html" title="FreeTDS User Guide" /><link rel="up" href="programming.html" title="Chapter 11. Programming" /><link rel="prev" href="dblib.api.summary.html" title="DB-Library API Implementation Summary" /><link rel="next" href="odbc.api.summary.html" title="ODBC API Implementation Summary" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">ct-lib API Implementation Summary</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="dblib.api.summary.html">Prev</a> </td><th width="60%" align="center">Chapter 11. Programming</th><td width="20%" align="right"> <a accesskey="n" href="odbc.api.summary.html">Next</a></td></tr></table><hr /></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="ctlib.api.summary"></a>ct-lib API Implementation Summary</h2></div></div></div><p>Sybase ct-lib documentation can be found <a class="ulink" href="http://manuals.sybase.com/onlinebooks/group-cnarc/cng1110e/ctref/@Generic__BookView" target="_top">online</a> and in <a class="ulink" href="http://download.sybase.com/pdfdocs/cng1000e/ref.pdf" target="_top">PDF</a> form. <a href="#ftn.idm5078" class="footnote" id="idm5078"><sup class="footnote">[27]</sup></a></p><div class="table"><a id="ctlib.api"></a><p class="title"><strong>Table 11.2. <code class="systemitem">CT-Library</code> API Implementation Summary</strong></p><div class="table-contents"><table class="table" summary="CT-Library API Implementation Summary" border="1"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Category</th><th>Function</th><th>Status</th><th>Comments</th></tr></thead><tbody><tr><td>(all)</td><td>ct_bind</td><td>OK</td><td>Bind server results to program variables.</td></tr><tr><td>(all)</td><td>ct_br_column</td><td>Retrieve information about a column generated by a browse mode select.</td><td class="auto-generated"> </td></tr><tr><td>(all)</td><td>ct_br_table</td><td>Return information about browse mode tables.</td><td class="auto-generated"> </td></tr><tr><td>(all)</td><td>ct_callback</td><td>OK</td><td>Install or retrieve a Client-Library callback routine.</td></tr><tr><td>(all)</td><td>ct_cancel</td><td>OK</td><td>Cancel a command or the results of a command.</td></tr><tr><td>(all)</td><td>ct_capability</td><td>OK</td><td>Set or retrieve a client/server capability.</td></tr><tr><td>(all)</td><td>ct_close</td><td>OK</td><td>Close a server connection.</td></tr><tr><td>(all)</td><td>ct_cmd_alloc</td><td>OK</td><td>Allocate a CS_COMMAND structure.</td></tr><tr><td>(all)</td><td>ct_cmd_drop</td><td>OK</td><td>Deallocate a CS_COMMAND structure.</td></tr><tr><td>(all)</td><td>ct_cmd_props</td><td>OK</td><td>Set or retrieve command structure properties. For use by applications that resend commands.</td></tr><tr><td>(all)</td><td>ct_command</td><td>OK</td><td>Initiate a language, package, RPC, message, or send-data command.</td></tr><tr><td>(all)</td><td>ct_compute_info</td><td>OK</td><td>Retrieve compute result information.</td></tr><tr><td>(all)</td><td>ct_con_alloc</td><td>OK</td><td>Allocate a CS_CONNECTION structure.</td></tr><tr><td>(all)</td><td>ct_con_drop</td><td>OK</td><td>Deallocate a CS_CONNECTION structure.</td></tr><tr><td>(all)</td><td>ct_con_props</td><td>OK</td><td>Set or retrieve connection structure properties.</td></tr><tr><td>(all)</td><td>ct_config</td><td>OK</td><td>Set or retrieve context properties.</td></tr><tr><td>(all)</td><td>ct_connect</td><td>OK</td><td>Connect to a server.</td></tr><tr><td>(all)</td><td>ct_cursor</td><td>OK</td><td>Initiate a Client-Library cursor command.</td></tr><tr><td>(all)</td><td>ct_data_info</td><td>OK</td><td>Define or retrieve a data I/O descriptor structure.</td></tr><tr><td>(all)</td><td>ct_debug</td><td>Manage debug library operations.</td><td class="auto-generated"> </td></tr><tr><td>(all)</td><td>ct_describe</td><td>OK</td><td>Return a description of result data.</td></tr><tr><td>(all)</td><td>ct_diag</td><td>OK</td><td>Manage inline error handling.</td></tr><tr><td>(all)</td><td>ct_ds_dropobj</td><td>Release the memory associated with a directory object.</td><td class="auto-generated"> </td></tr><tr><td>(all)</td><td>ct_ds_lookup</td><td>Initiate or cancel a directory lookup operation.</td><td class="auto-generated"> </td></tr><tr><td>(all)</td><td>ct_ds_objinfo</td><td>Retrieve information associated with a directory object.</td><td class="auto-generated"> </td></tr><tr><td>(all)</td><td>ct_dynamic</td><td>OK</td><td>Initiate a dynamic SQL command.</td></tr><tr><td>(all)</td><td>ct_dyndesc</td><td>Perform operations on a dynamic SQL descriptor area.</td><td class="auto-generated"> </td></tr><tr><td>(all)</td><td>ct_dynsqlda</td><td>Operate on a SQLDA structure.</td><td class="auto-generated"> </td></tr><tr><td>(all)</td><td>ct_exit</td><td>OK</td><td>Exit Client-Library.</td></tr><tr><td>(all)</td><td>ct_fetch</td><td>OK</td><td>Fetch result data.</td></tr><tr><td>(all)</td><td>ct_get_data</td><td>OK</td><td>Read a chunk of data from the server.</td></tr><tr><td>(all)</td><td>ct_getformat</td><td>Return the server user-defined format string associated with a result column.</td><td class="auto-generated"> </td></tr><tr><td>(all)</td><td>ct_getloginfo</td><td>Transfer TDS login response information from a CS_CONNECTION structure to a newly allocated CS_LOGINFO structure.</td><td class="auto-generated"> </td></tr><tr><td>(all)</td><td>ct_init</td><td>OK</td><td>Initialize Client-Library for an application context.</td></tr><tr><td>(all)</td><td>ct_keydata</td><td>Specify or extract the contents of a key column.</td><td class="auto-generated"> </td></tr><tr><td>(all)</td><td>ct_labels</td><td>Define a security label or clear security labels for a connection.</td><td class="auto-generated"> </td></tr><tr><td>(all)</td><td>ct_options</td><td>OK</td><td>Set, retrieve, or clear the values of server query-processing options.</td></tr><tr><td>(all)</td><td>ct_param</td><td>OK</td><td>Supply values for a server command's input parameters.</td></tr><tr><td>(all)</td><td>ct_poll</td><td>stub</td><td>Poll connections for asynchronous operation completions and registered procedure notifications.</td></tr><tr><td>(all)</td><td>ct_recvpassthru</td><td>Receive a TDS (Tabular Data Stream) packet from a server.</td><td class="auto-generated"> </td></tr><tr><td>(all)</td><td>ct_remote_pwd</td><td>Define or clear passwords to be used for server-to-server connections.</td><td class="auto-generated"> </td></tr><tr><td>(all)</td><td>ct_res_info</td><td>OK</td><td>Retrieve current result set or command information.</td></tr><tr><td>(all)</td><td>ct_results</td><td>OK</td><td>Set up result data to be processed.</td></tr><tr><td>(all)</td><td>ct_send</td><td>OK</td><td>Send a command to the server.</td></tr><tr><td>(all)</td><td>ct_send_data</td><td>OK</td><td>Send a chunk of text or image data to the server.</td></tr><tr><td>(all)</td><td>ct_sendpassthru</td><td>Send a Tabular Data Stream (TDS) packet to a server.</td><td class="auto-generated"> </td></tr><tr><td>(all)</td><td>ct_setloginfo</td><td>Transfer TDS login response information from a CS_LOGINFO structure to a CS_CONNECTION structure.</td><td class="auto-generated"> </td></tr><tr><td>(all)</td><td>ct_setparam</td><td>OK</td><td>Specify source variables from which ct_send reads input parameter values for a server command.</td></tr><tr><td>(all)</td><td>ct_wakeup</td><td>Call a connection's completion callback.</td><td class="auto-generated"> </td></tr><tr><td>(all)</td><td>cs_calc</td><td>Perform an arithmetic operation on two operands.</td><td class="auto-generated"> </td></tr><tr><td>(all)</td><td>cs_cmp</td><td>Compare two data values.</td><td class="auto-generated"> </td></tr><tr><td>(all)</td><td>cs_config</td><td>partial</td><td>Set or retrieve CS-Library properties.</td></tr><tr><td>(all)</td><td>cs_conv_mult</td><td>stub</td><td>Retrieve the conversion multiplier for converting character data from one character set to another.</td></tr><tr><td>(all)</td><td>cs_convert</td><td>OK</td><td>Convert a data value from one datatype, locale, or format to another datatype, locale, or format.</td></tr><tr><td>(all)</td><td>cs_ctx_alloc</td><td>OK</td><td>Allocate a CS_CONTEXT structure.</td></tr><tr><td>(all)</td><td>cs_ctx_drop</td><td>OK</td><td>Deallocate a CS_CONTEXT structure.</td></tr><tr><td>(all)</td><td>cs_ctx_global</td><td>OK</td><td>Allocate or return a CS_CONTEXT structure.</td></tr><tr><td>(all)</td><td>cs_diag</td><td>OK</td><td>Manage inline error handling.</td></tr><tr><td>(all)</td><td>cs_dt_crack</td><td>OK</td><td>Convert a machine-readable datetime value into a user-accessible format.</td></tr><tr><td>(all)</td><td>cs_dt_info</td><td>stub</td><td>Set or retrieve language-specific datetime information.</td></tr><tr><td>(all)</td><td>cs_loc_alloc</td><td>OK</td><td>Allocate a CS_LOCALE structure.</td></tr><tr><td>(all)</td><td>cs_loc_drop</td><td>OK</td><td>Deallocate a CS_LOCALE structure.</td></tr><tr><td>(all)</td><td>cs_locale</td><td>partial</td><td>Load a CS_LOCALE structure with localization values or retrieve the locale name previously used to load a CS_LOCALE structure.</td></tr><tr><td>(all)</td><td>cs_manage_convert</td><td>stub</td><td>Install or retrieve a user-defined character set conversion routine.</td></tr><tr><td>(all)</td><td>cs_objects</td><td>stub</td><td>Save, retrieve, or clear objects and data associated with them.</td></tr><tr><td>(all)</td><td>cs_set_convert</td><td>stub</td><td>Install or retrieve a user-defined conversion routine.</td></tr><tr><td>(all)</td><td>cs_setnull</td><td>stub</td><td>Define a null substitution value to be used when binding or converting NULL data.</td></tr><tr><td>(all)</td><td>cs_strbuild</td><td>OK</td><td>Construct native language message strings.</td></tr><tr><td>(all)</td><td>cs_strcmp</td><td>stub</td><td>Compare two strings using a specified sort order.</td></tr><tr><td>(all)</td><td>cs_time</td><td>stub</td><td>Retrieve the current date and time.</td></tr><tr><td>(all)</td><td>cs_will_convert</td><td>OK</td><td>Indicate whether a specific datatype conversion is available in the Client/Server libraries.</td></tr><tr><td>(all)</td><td>blk_alloc</td><td>OK</td><td>Allocate a CS_BLKDESC structure.</td></tr><tr><td>(all)</td><td>blk_bind</td><td>OK</td><td>Bind a program variable and a database column.</td></tr><tr><td>(all)</td><td>blk_colval</td><td>stub</td><td>Server-side routine to obtain the column value from a formatted bulk copy row.</td></tr><tr><td>(all)</td><td>blk_default</td><td>stub</td><td>Retrieve a column's default value.</td></tr><tr><td>(all)</td><td>blk_describe</td><td>OK</td><td>Retrieve a description of a database column.</td></tr><tr><td>(all)</td><td>blk_done</td><td>OK</td><td>Mark a complete bulk copy operation or a complete bulk copy batch.</td></tr><tr><td>(all)</td><td>blk_drop</td><td>OK</td><td>Deallocate a CS_BLKDESC structure.</td></tr><tr><td>(all)</td><td>blk_getrow</td><td>stub</td><td>Server-side routine to retrieve and store a formatted bulk copy row.</td></tr><tr><td>(all)</td><td>blk_gettext</td><td>stub</td><td>Server-side routine to retrieve the text, image, sensitivity, or boundary portion of an incoming bulk copy formatted row.</td></tr><tr><td>(all)</td><td>blk_init</td><td>OK</td><td>Initiate a bulk copy operation.</td></tr><tr><td>(all)</td><td>blk_props</td><td>OK</td><td>Set or retrieve bulk descriptor structure properties.</td></tr><tr><td>(all)</td><td>blk_rowalloc</td><td>stub</td><td>Server-side routine to allocate space for a formatted bulk copy row.</td></tr><tr><td>(all)</td><td>blk_rowdrop</td><td>stub</td><td>Server-side routine to free space previously allocated for a formatted bulk copy row.</td></tr><tr><td>(all)</td><td>blk_rowxfer</td><td>OK</td><td>Transfer one or more rows during a bulk copy operation without specifying or receiving a row count.</td></tr><tr><td>(all)</td><td>blk_rowxfer_mult</td><td>OK</td><td>Transfer one or more rows during a bulk copy operation.</td></tr><tr><td>(all)</td><td>blk_sendrow</td><td>stub</td><td>Server-side routine to send a formatted bulk copy row obtained from blk_getrow.</td></tr><tr><td>(all)</td><td>blk_sendtext</td><td>stub</td><td>Server-side routine to send text, image, sensitivity, or boundary data in a formatted bulk copy row obtained from blk_sendtext.</td></tr><tr><td>(all)</td><td>blk_srvinit</td><td>stub</td><td>Server-side routine to copy descriptions of server table columns to the client, if required.</td></tr><tr><td>(all)</td><td>blk_textxfer</td><td>stub</td><td>Transfer a column's data in chunks during a bulk copy operation.</td></tr></tbody></table></div></div><br class="table-break" /><div class="footnotes"><br /><hr style="width:100; text-align:left;margin-left: 0" /><div id="ftn.idm5078" class="footnote"><p><a href="#idm5078" class="para"><sup class="para">[27] </sup></a>Links such as these are quite perishable. Should you find them broken, please check the <a class="ulink" href="http://www.freetds.org/userguide/ctlib.api.summary.htm" target="_top"><span class="productname">FreeTDS</span> User Guide</a> posted on our website. If it's out of date, please let us know, so we can correct it. Thanks.</p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="dblib.api.summary.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="programming.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="odbc.api.summary.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><code class="systemitem">DB-Library</code> API Implementation Summary </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> ODBC API Implementation Summary</td></tr></table></div></body></html>