<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <HTML ><HEAD ><TITLE >API Reference Manual</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK REL="HOME" TITLE="FreeTDS User Guide" HREF="index.htm"><LINK REL="UP" TITLE="Programming" HREF="programming.htm"><LINK REL="PREVIOUS" TITLE="Programming" HREF="programming.htm"><LINK REL="NEXT" TITLE="DB-Library API Implementation Summary" HREF="dblib.api.summary.htm"><LINK REL="STYLESHEET" TYPE="text/css" HREF="userguide.css"><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"></HEAD ><BODY CLASS="SECT1" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#840084" ALINK="#0000FF" ><DIV CLASS="NAVHEADER" ><TABLE SUMMARY="Header navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" ><SPAN CLASS="PRODUCTNAME" >FreeTDS</SPAN > User Guide: A Guide to Installing, Configuring, and Running <SPAN CLASS="PRODUCTNAME" >FreeTDS</SPAN ></TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="programming.htm" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" >Chapter 11. Programming</TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="dblib.api.summary.htm" ACCESSKEY="N" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><DIV CLASS="SECT1" ><H1 CLASS="SECT1" ><A NAME="APIREFERENCE" >API Reference Manual</A ></H1 ><P >The <A 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 <B CLASS="COMMAND" >cd <TT CLASS="FILENAME" >doc</TT >; make doc</B >.</P ><P >The reference manual is a work in progress: only <SPAN CLASS="SYSTEMITEM" >DB-Library</SPAN > 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 HREF="http://www.stack.nl/~dimitri/doxygen/" TARGET="_top" >Doxygen website</A >.</P ><P >Basic API coverage information for the db-lib, ct-lib, and ODBC client libraries is maintained in <TT CLASS="FILENAME" >doc/api_status.txt</TT >, 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 NAME="AEN3491" HREF="#FTN.AEN3491" ><SPAN CLASS="footnote" >[1]</SPAN ></A > the extent to which it is implemented. The <SPAN CLASS="emphasis" ><I CLASS="EMPHASIS" >Status</I ></SPAN > field may be: <P ></P ><DIV CLASS="VARIABLELIST" ><P ><B ><SPAN CLASS="SYSTEMITEM" >DB-Library</SPAN > API function status domain</B ></P ><DL ><DT >(blank)</DT ><DD ><P >Function is not implemented.</P ></DD ><DT >stub</DT ><DD ><P >Function is implemented as a stub. Some such functions return <TT CLASS="LITERAL" >SUCCEED</TT > even though they have no effect, to satisfy upper layers.</P ></DD ><DT >Partial</DT ><DD ><P >Function is partly implemented. We haven't dealt with every possible option, for instance.</P ></DD ><DT >OK</DT ><DD ><P >Function is implemented. Completely, we claim.</P ></DD ></DL ></DIV ></P ></DIV ><H3 CLASS="FOOTNOTES" >Notes</H3 ><TABLE BORDER="0" CLASS="FOOTNOTES" WIDTH="100%" ><TR ><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="5%" ><A NAME="FTN.AEN3491" HREF="apireference.htm#AEN3491" ><SPAN CLASS="footnote" >[1]</SPAN ></A ></TD ><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="95%" ><P >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 ></TD ></TR ></TABLE ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="programming.htm" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.htm" ACCESSKEY="H" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="dblib.api.summary.htm" ACCESSKEY="N" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >Programming</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="programming.htm" ACCESSKEY="U" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><SPAN CLASS="SYSTEMITEM" >DB-Library</SPAN > API Implementation Summary</TD ></TR ></TABLE ></DIV ></BODY ></HTML >