<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>FreeTDS API: The db-lib API</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<h1>The db-lib API</h1>Functions callable by <code>db-lib</code> client programs.
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Modules</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00275.html">Primary functions</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Core functions needed by most db-lib programs. <br></td></tr>
<p>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00276.html">Remote Procedure functions</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Functions used with stored procedures. <br></td></tr>
<p>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00277.html">Bulk copy functions</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Functions to bulk-copy (a/k/a <em>bcp</em>) data to/from the database. <br></td></tr>
<p>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00279.html">Money functions</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Functions to manipulate the MONEY datatype. <br></td></tr>
<p>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html">Datetime functions</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Functions to manipulate DBDATETIME structures. <br></td></tr>
<p>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00281.html">Internals</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Functions called within <code>db-lib</code> for self-help. <br></td></tr>
<p>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00282.html">Unimplemented</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Functions thus far not implemented in the FreeTDS db-lib implementation. <br></td></tr>
<p>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00274.html#ga4">BCP_SETL</a>(x, y) dbsetlbool((x), (y), DBSETBCP)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable (or prevent) bcp operations for connections made with a login. <a href="#ga4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00274.html#ga3">DBSETLAPP</a>(x, y) dbsetlname((x), (y), DBSETAPP)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the (client) application name in the login packet. <a href="#ga3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00274.html#ga0">DBSETLHOST</a>(x, y) dbsetlname((x), (y), DBSETHOST)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the (client) host name in the login packet. <a href="#ga0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00274.html#ga2">DBSETLPWD</a>(x, y) dbsetlname((x), (y), DBSETPWD)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the password in the login packet. <a href="#ga2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00274.html#ga1">DBSETLUSER</a>(x, y) dbsetlname((x), (y), DBSETUSER)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the username in the login packet. <a href="#ga1"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Functions callable by <code>db-lib</code> client programs.
<p>
The <code>db_lib</code> interface is implemented by both Sybase and Microsoft. FreeTDS seeks to implement first the intersection of the functions defined by the vendors. <hr><h2>Define Documentation</h2>
<a class="anchor" name="ga4" doxytag="sybdb.h::BCP_SETL"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">BCP_SETL </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">x, <tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>y </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> dbsetlbool((x), (y), DBSETBCP)</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Enable (or prevent) bcp operations for connections made with a login.
<p>
<dl compact><dt><b>See also:</b></dt><dd>bcp_setl() </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga3" doxytag="sybdb.h::DBSETLAPP"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">DBSETLAPP </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">x, <tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>y </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> dbsetlname((x), (y), DBSETAPP)</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the (client) application name in the login packet.
<p>
<dl compact><dt><b>See also:</b></dt><dd>dbsetlapp() </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga0" doxytag="sybdb.h::DBSETLHOST"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">DBSETLHOST </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">x, <tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>y </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> dbsetlname((x), (y), DBSETHOST)</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the (client) host name in the login packet.
<p>
<dl compact><dt><b>See also:</b></dt><dd>dbsetlhost() </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga2" doxytag="sybdb.h::DBSETLPWD"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">DBSETLPWD </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">x, <tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>y </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> dbsetlname((x), (y), DBSETPWD)</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the password in the login packet.
<p>
<dl compact><dt><b>See also:</b></dt><dd>dbsetlpwd() </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga1" doxytag="sybdb.h::DBSETLUSER"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">DBSETLUSER </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">x, <tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>y </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> dbsetlname((x), (y), DBSETUSER)</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the username in the login packet.
<p>
<dl compact><dt><b>See also:</b></dt><dd>dbsetluser() </dd></dl>
</td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Wed May 7 19:22:10 2008 for FreeTDS API by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.1 </small></address>
</body>
</html>
