Sophie

Sophie

distrib > Mageia > 5 > x86_64 > media > core-release > by-pkgid > 13eec89779171a321fe518ddb0e0fec6 > files > 211

freetds-doc-0.91-8.mga5.x86_64.rpm

<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>FreeTDS API: The db-lib API</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <img id="MSearchSelect" src="search/search.png"
             onmouseover="return searchBox.OnSearchSelectShow()"
             onmouseout="return searchBox.OnSearchSelectHide()"
             alt=""/>
        <input type="text" id="MSearchField" value="Search" accesskey="S"
             onfocus="searchBox.OnSearchFieldFocus(true)" 
             onblur="searchBox.OnSearchFieldFocus(false)" 
             onkeyup="searchBox.OnSearchFieldChange(event)"/>
        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
        </div>
      </li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>The db-lib API</h1>
<p>Functions callable by <code>db-lib</code> client programs.  
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Modules</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00286.html">Primary functions</a></td></tr>

<p><tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><p>Core functions needed by most db-lib programs. </p>
<br/></td></tr>
</p>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00287.html">Remote Procedure functions</a></td></tr>

<p><tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><p>Functions used with stored procedures. </p>
<br/></td></tr>
</p>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00288.html">Bulk copy functions</a></td></tr>

<p><tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><p>Functions to bulk-copy (a/k/a <em>bcp</em>) data to/from the database. </p>
<br/></td></tr>
</p>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00290.html">Money functions</a></td></tr>

<p><tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><p>Functions to manipulate the MONEY datatype. </p>
<br/></td></tr>
</p>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00291.html">Datetime functions</a></td></tr>

<p><tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><p>Functions to manipulate <a class="el" href="a00055.html">DBDATETIME</a> structures. </p>
<br/></td></tr>
</p>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00292.html">Internals</a></td></tr>

<p><tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><p>Functions called within <code>db-lib</code> for self-help. </p>
<br/></td></tr>
</p>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00293.html">Unimplemented</a></td></tr>

<p><tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><p>Functions thus far not implemented in the FreeTDS db-lib implementation. </p>
<br/></td></tr>
</p>
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00285.html#ga5a626d228e82be0af8449d2b8c278241">BCP_SETL</a>(x, y)&nbsp;&nbsp;&nbsp;dbsetlbool((x), (y), DBSETBCP)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enable (or prevent) bcp operations for connections made with a login.  <a href="#ga5a626d228e82be0af8449d2b8c278241"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00285.html#gab6c2da7fd615cf7462d555e5387a5580">DBSETLAPP</a>(x, y)&nbsp;&nbsp;&nbsp;dbsetlname((x), (y), DBSETAPP)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the (client) application name in the login packet.  <a href="#gab6c2da7fd615cf7462d555e5387a5580"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00285.html#gaef0e7a5fcf2d8c8f795b2b06ce4de8b1">DBSETLHOST</a>(x, y)&nbsp;&nbsp;&nbsp;dbsetlname((x), (y), DBSETHOST)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the (client) host name in the login packet.  <a href="#gaef0e7a5fcf2d8c8f795b2b06ce4de8b1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00285.html#ga61e04e8e2f0d7f1740d40634041f98eb">DBSETLPWD</a>(x, y)&nbsp;&nbsp;&nbsp;dbsetlname((x), (y), DBSETPWD)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the password in the login packet.  <a href="#ga61e04e8e2f0d7f1740d40634041f98eb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00285.html#gafbe7e48171d2f9b1d4f99e0bfdd98f5e">DBSETLUSER</a>(x, y)&nbsp;&nbsp;&nbsp;dbsetlname((x), (y), DBSETUSER)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the username in the login packet.  <a href="#gafbe7e48171d2f9b1d4f99e0bfdd98f5e"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>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>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga5a626d228e82be0af8449d2b8c278241"></a><!-- doxytag: member="sybdb.h::BCP_SETL" ref="ga5a626d228e82be0af8449d2b8c278241" args="(x, y)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">BCP_SETL</td>
          <td>(</td>
          <td class="paramtype">x, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">y&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td>&nbsp;&nbsp;&nbsp;dbsetlbool((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="see"><dt><b>See also:</b></dt><dd>bcp_setl() </dd></dl>

</div>
</div>
<a class="anchor" id="gab6c2da7fd615cf7462d555e5387a5580"></a><!-- doxytag: member="sybdb.h::DBSETLAPP" ref="gab6c2da7fd615cf7462d555e5387a5580" args="(x, y)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">DBSETLAPP</td>
          <td>(</td>
          <td class="paramtype">x, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">y&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td>&nbsp;&nbsp;&nbsp;dbsetlname((x), (y), DBSETAPP)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Set the (client) application name in the login packet. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>dbsetlapp() </dd></dl>

</div>
</div>
<a class="anchor" id="gaef0e7a5fcf2d8c8f795b2b06ce4de8b1"></a><!-- doxytag: member="sybdb.h::DBSETLHOST" ref="gaef0e7a5fcf2d8c8f795b2b06ce4de8b1" args="(x, y)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">DBSETLHOST</td>
          <td>(</td>
          <td class="paramtype">x, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">y&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td>&nbsp;&nbsp;&nbsp;dbsetlname((x), (y), DBSETHOST)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Set the (client) host name in the login packet. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>dbsetlhost() </dd></dl>

</div>
</div>
<a class="anchor" id="ga61e04e8e2f0d7f1740d40634041f98eb"></a><!-- doxytag: member="sybdb.h::DBSETLPWD" ref="ga61e04e8e2f0d7f1740d40634041f98eb" args="(x, y)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">DBSETLPWD</td>
          <td>(</td>
          <td class="paramtype">x, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">y&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td>&nbsp;&nbsp;&nbsp;dbsetlname((x), (y), DBSETPWD)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Set the password in the login packet. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>dbsetlpwd() </dd></dl>

</div>
</div>
<a class="anchor" id="gafbe7e48171d2f9b1d4f99e0bfdd98f5e"></a><!-- doxytag: member="sybdb.h::DBSETLUSER" ref="gafbe7e48171d2f9b1d4f99e0bfdd98f5e" args="(x, y)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">DBSETLUSER</td>
          <td>(</td>
          <td class="paramtype">x, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">y&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td>&nbsp;&nbsp;&nbsp;dbsetlname((x), (y), DBSETUSER)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Set the username in the login packet. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>dbsetluser() </dd></dl>

</div>
</div>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&nbsp;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&nbsp;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&nbsp;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 17 22:22:31 2011 for FreeTDS API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>