JezK
Edit File: apireference.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>API Reference Manual</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="programming.html" title="Chapter 11. Programming" /><link rel="next" href="dblib.api.summary.html" title="DB-Library API Implementation Summary" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">API Reference Manual</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="programming.html">Prev</a> </td><th width="60%" align="center">Chapter 11. Programming</th><td width="20%" align="right"> <a accesskey="n" href="dblib.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="apireference"></a>API Reference Manual</h2></div></div></div><p>The <a class="ulink" href="../reference/index.html" target="_top">reference manual</a> is installed as part of <span class="productname">FreeTDS</span>. It can be regenerated at any time using <span class="productname">Doxygen</span> with <span class="command"><strong>cd <code class="filename">doc</code>; make doc</strong></span>.</p><p>The reference manual is a work in progress: only <code class="systemitem">DB-Library</code> is completely documented, and quite minimally at that. Should you find it inadequate, you may be interested to learn it's not hard to add to, technically. <span class="productname">Doxygen</span> generates a manual from encoded comments in the source code. Its markup syntax is not hard to learn. You can read more about it at the <a class="ulink" href="http://www.doxygen.org" target="_top">Doxygen website</a>.</p><p>Basic API coverage information for the db-lib, ct-lib, and ODBC client libraries is maintained in <code class="filename">doc/api_status.txt</code>, included in the source distribution. For your convenience and enjoyment, we include that file in the following sections. In each table, we note for the function <a href="#ftn.idm3735" class="footnote" id="idm3735"><sup class="footnote">[25]</sup></a> the extent to which it is implemented. The <span class="emphasis"><em>Status</em></span> field may be: </p><div class="variablelist"><a id="dblib.api.status"></a><p class="title"><strong><code class="systemitem">DB-Library</code> API function status domain</strong></p><dl class="variablelist"><dt><span class="term">(blank)</span></dt><dd><p>Function is not implemented.</p></dd><dt><span class="term">stub</span></dt><dd><p>Function is implemented as a stub. Some such functions return <code class="literal">SUCCEED</code> even though they have no effect, to satisfy upper layers.</p></dd><dt><span class="term">Partial</span></dt><dd><p>Function is partly implemented. We haven't dealt with every possible option, for instance.</p></dd><dt><span class="term">OK</span></dt><dd><p>Function is implemented. Completely, we claim.</p></dd></dl></div><div class="footnotes"><br /><hr style="width:100; text-align:left;margin-left: 0" /><div id="ftn.idm3735" class="footnote"><p><a href="#idm3735" class="para"><sup class="para">[25] </sup></a>Sybase and Microsoft sometimes use slightly different names for the same function. It is the intention of the <code class="option">--enable-msdblib</code> option to align <span class="productname">FreeTDS</span> with one or the other's convention.</p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="programming.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="dblib.api.summary.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 11. Programming </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> <code class="systemitem">DB-Library</code> API Implementation Summary</td></tr></table></div></body></html>