<!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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FreeTDS API: The db-lib API</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">FreeTDS API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> |
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">The db-lib API</div> </div>
</div><!--header-->
<div class="contents">
<p>Functions callable by <code>db-lib</code> client programs.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for The db-lib API:</div>
<div class="dyncontent">
<center><table><tr><td><div class="center"><iframe scrolling="no" frameborder="0" src="a00517.svg" width="368" height="342"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:a00518"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00518.html">Primary functions</a></td></tr>
<tr class="memdesc:a00518"><td class="mdescLeft"> </td><td class="mdescRight">Core functions needed by most db-lib programs. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00519"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00519.html">Remote Procedure functions</a></td></tr>
<tr class="memdesc:a00519"><td class="mdescLeft"> </td><td class="mdescRight">Functions used with stored procedures. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00520"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00520.html">Bulk copy functions</a></td></tr>
<tr class="memdesc:a00520"><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>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00522"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00522.html">Money functions</a></td></tr>
<tr class="memdesc:a00522"><td class="mdescLeft"> </td><td class="mdescRight">Functions to manipulate the MONEY datatype. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00523"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00523.html">Datetime functions</a></td></tr>
<tr class="memdesc:a00523"><td class="mdescLeft"> </td><td class="mdescRight">Functions to manipulate <a class="el" href="a01257.html">DBDATETIME</a> structures. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00524"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00524.html">Internals</a></td></tr>
<tr class="memdesc:a00524"><td class="mdescLeft"> </td><td class="mdescRight">Functions called within <code>db-lib</code> for self-help. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00525"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00525.html">Unimplemented</a></td></tr>
<tr class="memdesc:a00525"><td class="mdescLeft"> </td><td class="mdescRight">Functions thus far not implemented in the FreeTDS db-lib implementation. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga5a626d228e82be0af8449d2b8c278241"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00517.html#ga5a626d228e82be0af8449d2b8c278241">BCP_SETL</a>(x, y)   <a class="el" href="a00524.html#ga03e850369aca6fba074da5e9da4effd7">dbsetlbool</a>((x), (y), DBSETBCP)</td></tr>
<tr class="memdesc:ga5a626d228e82be0af8449d2b8c278241"><td class="mdescLeft"> </td><td class="mdescRight">Enable (or prevent) bcp operations for connections made with a login. <a href="#ga5a626d228e82be0af8449d2b8c278241">More...</a><br /></td></tr>
<tr class="separator:ga5a626d228e82be0af8449d2b8c278241"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab6c2da7fd615cf7462d555e5387a5580"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00517.html#gab6c2da7fd615cf7462d555e5387a5580">DBSETLAPP</a>(x, y)   <a class="el" href="a00524.html#gae1fc46447c4f8a9ff7f66607b8cd23b6">dbsetlname</a>((x), (y), DBSETAPP)</td></tr>
<tr class="memdesc:gab6c2da7fd615cf7462d555e5387a5580"><td class="mdescLeft"> </td><td class="mdescRight">Set the (client) application name in the login packet. <a href="#gab6c2da7fd615cf7462d555e5387a5580">More...</a><br /></td></tr>
<tr class="separator:gab6c2da7fd615cf7462d555e5387a5580"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaef0e7a5fcf2d8c8f795b2b06ce4de8b1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00517.html#gaef0e7a5fcf2d8c8f795b2b06ce4de8b1">DBSETLHOST</a>(x, y)   <a class="el" href="a00524.html#gae1fc46447c4f8a9ff7f66607b8cd23b6">dbsetlname</a>((x), (y), DBSETHOST)</td></tr>
<tr class="memdesc:gaef0e7a5fcf2d8c8f795b2b06ce4de8b1"><td class="mdescLeft"> </td><td class="mdescRight">Set the (client) host name in the login packet. <a href="#gaef0e7a5fcf2d8c8f795b2b06ce4de8b1">More...</a><br /></td></tr>
<tr class="separator:gaef0e7a5fcf2d8c8f795b2b06ce4de8b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga61e04e8e2f0d7f1740d40634041f98eb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00517.html#ga61e04e8e2f0d7f1740d40634041f98eb">DBSETLPWD</a>(x, y)   <a class="el" href="a00524.html#gae1fc46447c4f8a9ff7f66607b8cd23b6">dbsetlname</a>((x), (y), DBSETPWD)</td></tr>
<tr class="memdesc:ga61e04e8e2f0d7f1740d40634041f98eb"><td class="mdescLeft"> </td><td class="mdescRight">Set the password in the login packet. <a href="#ga61e04e8e2f0d7f1740d40634041f98eb">More...</a><br /></td></tr>
<tr class="separator:ga61e04e8e2f0d7f1740d40634041f98eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafbe7e48171d2f9b1d4f99e0bfdd98f5e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00517.html#gafbe7e48171d2f9b1d4f99e0bfdd98f5e">DBSETLUSER</a>(x, y)   <a class="el" href="a00524.html#gae1fc46447c4f8a9ff7f66607b8cd23b6">dbsetlname</a>((x), (y), DBSETUSER)</td></tr>
<tr class="memdesc:gafbe7e48171d2f9b1d4f99e0bfdd98f5e"><td class="mdescLeft"> </td><td class="mdescRight">Set the username in the login packet. <a href="#gafbe7e48171d2f9b1d4f99e0bfdd98f5e">More...</a><br /></td></tr>
<tr class="separator:gafbe7e48171d2f9b1d4f99e0bfdd98f5e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions callable by <code>db-lib</code> client programs. </p>
<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. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga5a626d228e82be0af8449d2b8c278241"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5a626d228e82be0af8449d2b8c278241">§ </a></span>BCP_SETL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BCP_SETL</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">x, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">y </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="a00524.html#ga03e850369aca6fba074da5e9da4effd7">dbsetlbool</a>((x), (y), DBSETBCP)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable (or prevent) bcp operations for connections made with a login. </p>
<dl class="section see"><dt>See also</dt><dd>bcp_setl() </dd></dl>
</div>
</div>
<a id="gab6c2da7fd615cf7462d555e5387a5580"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab6c2da7fd615cf7462d555e5387a5580">§ </a></span>DBSETLAPP</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DBSETLAPP</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">x, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">y </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="a00524.html#gae1fc46447c4f8a9ff7f66607b8cd23b6">dbsetlname</a>((x), (y), DBSETAPP)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the (client) application name in the login packet. </p>
<dl class="section see"><dt>See also</dt><dd>dbsetlapp() </dd></dl>
</div>
</div>
<a id="gaef0e7a5fcf2d8c8f795b2b06ce4de8b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaef0e7a5fcf2d8c8f795b2b06ce4de8b1">§ </a></span>DBSETLHOST</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DBSETLHOST</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">x, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">y </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="a00524.html#gae1fc46447c4f8a9ff7f66607b8cd23b6">dbsetlname</a>((x), (y), DBSETHOST)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the (client) host name in the login packet. </p>
<dl class="section see"><dt>See also</dt><dd>dbsetlhost() </dd></dl>
</div>
</div>
<a id="ga61e04e8e2f0d7f1740d40634041f98eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga61e04e8e2f0d7f1740d40634041f98eb">§ </a></span>DBSETLPWD</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DBSETLPWD</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">x, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">y </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="a00524.html#gae1fc46447c4f8a9ff7f66607b8cd23b6">dbsetlname</a>((x), (y), DBSETPWD)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the password in the login packet. </p>
<dl class="section see"><dt>See also</dt><dd>dbsetlpwd() </dd></dl>
</div>
</div>
<a id="gafbe7e48171d2f9b1d4f99e0bfdd98f5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafbe7e48171d2f9b1d4f99e0bfdd98f5e">§ </a></span>DBSETLUSER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DBSETLUSER</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">x, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">y </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="a00524.html#gae1fc46447c4f8a9ff7f66607b8cd23b6">dbsetlname</a>((x), (y), DBSETUSER)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the username in the login packet. </p>
<dl class="section see"><dt>See also</dt><dd>dbsetluser() </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
