<!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: Remote Procedure functions</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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Remote Procedure functions<div class="ingroups"><a class="el" href="a00517.html">The db-lib API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Functions used with stored procedures.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Remote Procedure functions:</div>
<div class="dyncontent">
<center><table><tr><td><div class="center"><iframe scrolling="no" frameborder="0" src="a00519.svg" width="368" height="38"><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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga7a5062dac92ccedc8459f6d4a530ffb7"><td class="memItemLeft" align="right" valign="top">DBBOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="a00519.html#ga7a5062dac92ccedc8459f6d4a530ffb7">dbhasretstat</a> (<a class="el" href="a00901.html">DBPROCESS</a> *dbproc)</td></tr>
<tr class="memdesc:ga7a5062dac92ccedc8459f6d4a530ffb7"><td class="mdescLeft"> </td><td class="mdescRight">Determine if query generated a return status number. <a href="#ga7a5062dac92ccedc8459f6d4a530ffb7">More...</a><br /></td></tr>
<tr class="separator:ga7a5062dac92ccedc8459f6d4a530ffb7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaff09873008411a0573f6d1a9e6c7cf4b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00519.html#gaff09873008411a0573f6d1a9e6c7cf4b">dbnumrets</a> (<a class="el" href="a00901.html">DBPROCESS</a> *dbproc)</td></tr>
<tr class="memdesc:gaff09873008411a0573f6d1a9e6c7cf4b"><td class="mdescLeft"> </td><td class="mdescRight">Get count of output parameters filled by a stored procedure. <a href="#gaff09873008411a0573f6d1a9e6c7cf4b">More...</a><br /></td></tr>
<tr class="separator:gaff09873008411a0573f6d1a9e6c7cf4b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga42e187003b74fec6e9ca92d410bfb9c0"><td class="memItemLeft" align="right" valign="top">BYTE * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00519.html#ga42e187003b74fec6e9ca92d410bfb9c0">dbretdata</a> (<a class="el" href="a00901.html">DBPROCESS</a> *dbproc, int retnum)</td></tr>
<tr class="memdesc:ga42e187003b74fec6e9ca92d410bfb9c0"><td class="mdescLeft"> </td><td class="mdescRight">Get value of an output parameter filled by a stored procedure. <a href="#ga42e187003b74fec6e9ca92d410bfb9c0">More...</a><br /></td></tr>
<tr class="separator:ga42e187003b74fec6e9ca92d410bfb9c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab705bf94be535e9d8fc4edc0f48c98b0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00519.html#gab705bf94be535e9d8fc4edc0f48c98b0">dbretlen</a> (<a class="el" href="a00901.html">DBPROCESS</a> *dbproc, int retnum)</td></tr>
<tr class="memdesc:gab705bf94be535e9d8fc4edc0f48c98b0"><td class="mdescLeft"> </td><td class="mdescRight">Get size of an output parameter filled by a stored procedure. <a href="#gab705bf94be535e9d8fc4edc0f48c98b0">More...</a><br /></td></tr>
<tr class="separator:gab705bf94be535e9d8fc4edc0f48c98b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0311328d63bae5d9bd5aea5ea4914223"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00519.html#ga0311328d63bae5d9bd5aea5ea4914223">dbretname</a> (<a class="el" href="a00901.html">DBPROCESS</a> *dbproc, int retnum)</td></tr>
<tr class="memdesc:ga0311328d63bae5d9bd5aea5ea4914223"><td class="mdescLeft"> </td><td class="mdescRight">Get name of an output parameter filled by a stored procedure. <a href="#ga0311328d63bae5d9bd5aea5ea4914223">More...</a><br /></td></tr>
<tr class="separator:ga0311328d63bae5d9bd5aea5ea4914223"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2306039d73fbc7045f257b0e750c37b4"><td class="memItemLeft" align="right" valign="top">DBINT </td><td class="memItemRight" valign="bottom"><a class="el" href="a00519.html#ga2306039d73fbc7045f257b0e750c37b4">dbretstatus</a> (<a class="el" href="a00901.html">DBPROCESS</a> *dbproc)</td></tr>
<tr class="memdesc:ga2306039d73fbc7045f257b0e750c37b4"><td class="mdescLeft"> </td><td class="mdescRight">Fetch status value returned by query or remote procedure call. <a href="#ga2306039d73fbc7045f257b0e750c37b4">More...</a><br /></td></tr>
<tr class="separator:ga2306039d73fbc7045f257b0e750c37b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa478c8b96923bca02d158d966172ec1b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00519.html#gaa478c8b96923bca02d158d966172ec1b">dbrettype</a> (<a class="el" href="a00901.html">DBPROCESS</a> *dbproc, int retnum)</td></tr>
<tr class="memdesc:gaa478c8b96923bca02d158d966172ec1b"><td class="mdescLeft"> </td><td class="mdescRight">Get datatype of a stored procedure's return parameter. <a href="#gaa478c8b96923bca02d158d966172ec1b">More...</a><br /></td></tr>
<tr class="separator:gaa478c8b96923bca02d158d966172ec1b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5b4374c13c7a83cd4345b0bfa3e787bd"><td class="memItemLeft" align="right" valign="top">RETCODE </td><td class="memItemRight" valign="bottom"><a class="el" href="a00519.html#ga5b4374c13c7a83cd4345b0bfa3e787bd">dbrpcinit</a> (<a class="el" href="a00901.html">DBPROCESS</a> *dbproc, const char rpcname[], DBSMALLINT options)</td></tr>
<tr class="memdesc:ga5b4374c13c7a83cd4345b0bfa3e787bd"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a remote procedure call. <a href="#ga5b4374c13c7a83cd4345b0bfa3e787bd">More...</a><br /></td></tr>
<tr class="separator:ga5b4374c13c7a83cd4345b0bfa3e787bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf6b6b0a641180a5c28382df39cd7d346"><td class="memItemLeft" align="right" valign="top">RETCODE </td><td class="memItemRight" valign="bottom"><a class="el" href="a00519.html#gaf6b6b0a641180a5c28382df39cd7d346">dbrpcparam</a> (<a class="el" href="a00901.html">DBPROCESS</a> *dbproc, const char paramname[], BYTE status, int db_type, DBINT maxlen, DBINT datalen, BYTE *value)</td></tr>
<tr class="memdesc:gaf6b6b0a641180a5c28382df39cd7d346"><td class="mdescLeft"> </td><td class="mdescRight">Add a parameter to a remote procedure call. <a href="#gaf6b6b0a641180a5c28382df39cd7d346">More...</a><br /></td></tr>
<tr class="separator:gaf6b6b0a641180a5c28382df39cd7d346"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafa4dfd181be21e49c397f7daaa9cf96c"><td class="memItemLeft" align="right" valign="top">RETCODE </td><td class="memItemRight" valign="bottom"><a class="el" href="a00519.html#gafa4dfd181be21e49c397f7daaa9cf96c">dbrpcsend</a> (<a class="el" href="a00901.html">DBPROCESS</a> *dbproc)</td></tr>
<tr class="memdesc:gafa4dfd181be21e49c397f7daaa9cf96c"><td class="mdescLeft"> </td><td class="mdescRight">Execute the procedure and free associated memory. <a href="#gafa4dfd181be21e49c397f7daaa9cf96c">More...</a><br /></td></tr>
<tr class="separator:gafa4dfd181be21e49c397f7daaa9cf96c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions used with stored procedures. </p>
<p>Especially useful for OUTPUT parameters, because modern Microsoft servers do not return output parameter data to the client unless the procedure was invoked with <a class="el" href="a00519.html#gafa4dfd181be21e49c397f7daaa9cf96c" title="Execute the procedure and free associated memory. ">dbrpcsend()</a>. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga7a5062dac92ccedc8459f6d4a530ffb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7a5062dac92ccedc8459f6d4a530ffb7">§ </a></span>dbhasretstat()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DBBOOL dbhasretstat </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00901.html">DBPROCESS</a> * </td>
<td class="paramname"><em>dbproc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine if query generated a return status number. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dbproc</td><td>contains all information needed by db-lib to manage communications with the server. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">TRUE</td><td>fetch return status with <a class="el" href="a00519.html#ga2306039d73fbc7045f257b0e750c37b4" title="Fetch status value returned by query or remote procedure call. ">dbretstatus()</a>. </td></tr>
<tr><td class="paramname">FALSE</td><td>no return status. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>dbnextrow(), <a class="el" href="a00518.html#ga4e26d949be2c3bf71b1a33c75b11d931" title="Set up query results. ">dbresults()</a>, <a class="el" href="a00519.html#ga42e187003b74fec6e9ca92d410bfb9c0" title="Get value of an output parameter filled by a stored procedure. ">dbretdata()</a>, <a class="el" href="a00519.html#ga2306039d73fbc7045f257b0e750c37b4" title="Fetch status value returned by query or remote procedure call. ">dbretstatus()</a>, <a class="el" href="a00519.html#ga5b4374c13c7a83cd4345b0bfa3e787bd" title="Initialize a remote procedure call. ">dbrpcinit()</a>, <a class="el" href="a00519.html#gaf6b6b0a641180a5c28382df39cd7d346" title="Add a parameter to a remote procedure call. ">dbrpcparam()</a>, <a class="el" href="a00519.html#gafa4dfd181be21e49c397f7daaa9cf96c" title="Execute the procedure and free associated memory. ">dbrpcsend()</a>. </dd></dl>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="a00519_ga7a5062dac92ccedc8459f6d4a530ffb7_cgraph.svg" width="262" height="38"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
<a id="gaff09873008411a0573f6d1a9e6c7cf4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaff09873008411a0573f6d1a9e6c7cf4b">§ </a></span>dbnumrets()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dbnumrets </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00901.html">DBPROCESS</a> * </td>
<td class="paramname"><em>dbproc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get count of output parameters filled by a stored procedure. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dbproc</td><td>contains all information needed by db-lib to manage communications with the server. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>How many, possibly zero. </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd>This name sounds funny. </dd></dl>
<dl class="section see"><dt>See also</dt><dd></dd></dl>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="a00519_gaff09873008411a0573f6d1a9e6c7cf4b_cgraph.svg" width="248" height="38"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
<a id="ga42e187003b74fec6e9ca92d410bfb9c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga42e187003b74fec6e9ca92d410bfb9c0">§ </a></span>dbretdata()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BYTE* dbretdata </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00901.html">DBPROCESS</a> * </td>
<td class="paramname"><em>dbproc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>retnum</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get value of an output parameter filled by a stored procedure. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dbproc</td><td>contains all information needed by db-lib to manage communications with the server. </td></tr>
<tr><td class="paramname">retnum</td><td>Nth parameter between <code>1</code> and the return value from <code><a class="el" href="a00519.html#gaff09873008411a0573f6d1a9e6c7cf4b" title="Get count of output parameters filled by a stored procedure. ">dbnumrets()</a></code>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Address of a return parameter value, or <code>NULL</code> if no such <em>retnum</em>. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>dbnextrow(), <a class="el" href="a00519.html#gaff09873008411a0573f6d1a9e6c7cf4b" title="Get count of output parameters filled by a stored procedure. ">dbnumrets()</a>, <a class="el" href="a00518.html#ga4e26d949be2c3bf71b1a33c75b11d931" title="Set up query results. ">dbresults()</a>, <a class="el" href="a00519.html#gab705bf94be535e9d8fc4edc0f48c98b0" title="Get size of an output parameter filled by a stored procedure. ">dbretlen()</a>, <a class="el" href="a00519.html#ga0311328d63bae5d9bd5aea5ea4914223" title="Get name of an output parameter filled by a stored procedure. ">dbretname()</a>, <a class="el" href="a00519.html#gaa478c8b96923bca02d158d966172ec1b" title="Get datatype of a stored procedure's return parameter. ">dbrettype()</a>, <a class="el" href="a00519.html#ga5b4374c13c7a83cd4345b0bfa3e787bd" title="Initialize a remote procedure call. ">dbrpcinit()</a>, <a class="el" href="a00519.html#gaf6b6b0a641180a5c28382df39cd7d346" title="Add a parameter to a remote procedure call. ">dbrpcparam()</a>. </dd></dl>
<dl class="todo"><dt><b><a class="el" href="a00515.html#_todo000012">Todo:</a></b></dt><dd>Handle blobs. </dd></dl>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="a00519_ga42e187003b74fec6e9ca92d410bfb9c0_cgraph.svg" width="244" height="38"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
<a id="gab705bf94be535e9d8fc4edc0f48c98b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab705bf94be535e9d8fc4edc0f48c98b0">§ </a></span>dbretlen()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dbretlen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00901.html">DBPROCESS</a> * </td>
<td class="paramname"><em>dbproc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>retnum</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get size of an output parameter filled by a stored procedure. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dbproc</td><td>contains all information needed by db-lib to manage communications with the server. </td></tr>
<tr><td class="paramname">retnum</td><td>Nth parameter between <code>1</code> and the return value from <code><a class="el" href="a00519.html#gaff09873008411a0573f6d1a9e6c7cf4b" title="Get count of output parameters filled by a stored procedure. ">dbnumrets()</a></code>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Size of a return parameter value, or <code>NULL</code> if no such <em>retnum</em>. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>dbnextrow(), <a class="el" href="a00519.html#gaff09873008411a0573f6d1a9e6c7cf4b" title="Get count of output parameters filled by a stored procedure. ">dbnumrets()</a>, <a class="el" href="a00518.html#ga4e26d949be2c3bf71b1a33c75b11d931" title="Set up query results. ">dbresults()</a>, <a class="el" href="a00519.html#ga42e187003b74fec6e9ca92d410bfb9c0" title="Get value of an output parameter filled by a stored procedure. ">dbretdata()</a>, <a class="el" href="a00519.html#ga0311328d63bae5d9bd5aea5ea4914223" title="Get name of an output parameter filled by a stored procedure. ">dbretname()</a>, <a class="el" href="a00519.html#gaa478c8b96923bca02d158d966172ec1b" title="Get datatype of a stored procedure's return parameter. ">dbrettype()</a>, <a class="el" href="a00519.html#ga5b4374c13c7a83cd4345b0bfa3e787bd" title="Initialize a remote procedure call. ">dbrpcinit()</a>, <a class="el" href="a00519.html#gaf6b6b0a641180a5c28382df39cd7d346" title="Add a parameter to a remote procedure call. ">dbrpcparam()</a>. </dd></dl>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="a00519_gab705bf94be535e9d8fc4edc0f48c98b0_cgraph.svg" width="235" height="38"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
<a id="ga0311328d63bae5d9bd5aea5ea4914223"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0311328d63bae5d9bd5aea5ea4914223">§ </a></span>dbretname()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* dbretname </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00901.html">DBPROCESS</a> * </td>
<td class="paramname"><em>dbproc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>retnum</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get name of an output parameter filled by a stored procedure. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dbproc</td><td>contains all information needed by db-lib to manage communications with the server. </td></tr>
<tr><td class="paramname">retnum</td><td>Nth parameter between <code>1</code> and the return value from <code><a class="el" href="a00519.html#gaff09873008411a0573f6d1a9e6c7cf4b" title="Get count of output parameters filled by a stored procedure. ">dbnumrets()</a></code>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>ASCII null-terminated string, <code>NULL</code> if no such <em>retnum</em>. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>dbnextrow(), <a class="el" href="a00519.html#gaff09873008411a0573f6d1a9e6c7cf4b" title="Get count of output parameters filled by a stored procedure. ">dbnumrets()</a>, <a class="el" href="a00518.html#ga4e26d949be2c3bf71b1a33c75b11d931" title="Set up query results. ">dbresults()</a>, <a class="el" href="a00519.html#ga42e187003b74fec6e9ca92d410bfb9c0" title="Get value of an output parameter filled by a stored procedure. ">dbretdata()</a>, <a class="el" href="a00519.html#gab705bf94be535e9d8fc4edc0f48c98b0" title="Get size of an output parameter filled by a stored procedure. ">dbretlen()</a>, <a class="el" href="a00519.html#gaa478c8b96923bca02d158d966172ec1b" title="Get datatype of a stored procedure's return parameter. ">dbrettype()</a>, <a class="el" href="a00519.html#ga5b4374c13c7a83cd4345b0bfa3e787bd" title="Initialize a remote procedure call. ">dbrpcinit()</a>, <a class="el" href="a00519.html#gaf6b6b0a641180a5c28382df39cd7d346" title="Add a parameter to a remote procedure call. ">dbrpcparam()</a>. </dd></dl>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="a00519_ga0311328d63bae5d9bd5aea5ea4914223_cgraph.svg" width="251" height="38"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
<a id="ga2306039d73fbc7045f257b0e750c37b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2306039d73fbc7045f257b0e750c37b4">§ </a></span>dbretstatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DBINT dbretstatus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00901.html">DBPROCESS</a> * </td>
<td class="paramname"><em>dbproc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fetch status value returned by query or remote procedure call. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dbproc</td><td>contains all information needed by db-lib to manage communications with the server. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>return value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00519.html#ga7a5062dac92ccedc8459f6d4a530ffb7" title="Determine if query generated a return status number. ">dbhasretstat()</a>, dbnextrow(), <a class="el" href="a00518.html#ga4e26d949be2c3bf71b1a33c75b11d931" title="Set up query results. ">dbresults()</a>, <a class="el" href="a00519.html#ga42e187003b74fec6e9ca92d410bfb9c0" title="Get value of an output parameter filled by a stored procedure. ">dbretdata()</a>, <a class="el" href="a00519.html#ga5b4374c13c7a83cd4345b0bfa3e787bd" title="Initialize a remote procedure call. ">dbrpcinit()</a>, <a class="el" href="a00519.html#gaf6b6b0a641180a5c28382df39cd7d346" title="Add a parameter to a remote procedure call. ">dbrpcparam()</a>, <a class="el" href="a00519.html#gafa4dfd181be21e49c397f7daaa9cf96c" title="Execute the procedure and free associated memory. ">dbrpcsend()</a>. </dd></dl>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="a00519_ga2306039d73fbc7045f257b0e750c37b4_cgraph.svg" width="252" height="38"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
<a id="gaa478c8b96923bca02d158d966172ec1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa478c8b96923bca02d158d966172ec1b">§ </a></span>dbrettype()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dbrettype </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00901.html">DBPROCESS</a> * </td>
<td class="paramname"><em>dbproc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>retnum</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get datatype of a stored procedure's return parameter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dbproc</td><td>contains all information needed by db-lib to manage communications with the server. </td></tr>
<tr><td class="paramname">retnum</td><td>Nth return parameter, between 1 and <code><a class="el" href="a00519.html#gaff09873008411a0573f6d1a9e6c7cf4b" title="Get count of output parameters filled by a stored procedure. ">dbnumrets()</a></code>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SYB* datatype token, or -1 if <em>retnum</em> is out of range. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>dbnextrow(), <a class="el" href="a00519.html#gaff09873008411a0573f6d1a9e6c7cf4b" title="Get count of output parameters filled by a stored procedure. ">dbnumrets()</a>, <a class="el" href="a00518.html#gac25ae21ca19777ffab1c013bd6049ebf" title="Print a token value's name to a buffer. ">dbprtype()</a>, <a class="el" href="a00518.html#ga4e26d949be2c3bf71b1a33c75b11d931" title="Set up query results. ">dbresults()</a>, <a class="el" href="a00519.html#ga42e187003b74fec6e9ca92d410bfb9c0" title="Get value of an output parameter filled by a stored procedure. ">dbretdata()</a>, <a class="el" href="a00519.html#gab705bf94be535e9d8fc4edc0f48c98b0" title="Get size of an output parameter filled by a stored procedure. ">dbretlen()</a>, <a class="el" href="a00519.html#ga0311328d63bae5d9bd5aea5ea4914223" title="Get name of an output parameter filled by a stored procedure. ">dbretname()</a>, <a class="el" href="a00519.html#ga5b4374c13c7a83cd4345b0bfa3e787bd" title="Initialize a remote procedure call. ">dbrpcinit()</a>, <a class="el" href="a00519.html#gaf6b6b0a641180a5c28382df39cd7d346" title="Add a parameter to a remote procedure call. ">dbrpcparam()</a>. </dd></dl>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="a00519_gaa478c8b96923bca02d158d966172ec1b_cgraph.svg" width="243" height="38"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
<a id="ga5b4374c13c7a83cd4345b0bfa3e787bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5b4374c13c7a83cd4345b0bfa3e787bd">§ </a></span>dbrpcinit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RETCODE dbrpcinit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00901.html">DBPROCESS</a> * </td>
<td class="paramname"><em>dbproc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char </td>
<td class="paramname"><em>rpcname</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">DBSMALLINT </td>
<td class="paramname"><em>options</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a remote procedure call. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dbproc</td><td>contains all information needed by db-lib to manage communications with the server. </td></tr>
<tr><td class="paramname">rpcname</td><td>name of the stored procedure to be run. </td></tr>
<tr><td class="paramname">options</td><td>Only supported option would be DBRPCRECOMPILE, which causes the stored procedure to be recompiled before executing. </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>The RPC functions are the only way to get back OUTPUT parameter data with db-lib from modern Microsoft servers. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">SUCCEED</td><td>normal. </td></tr>
<tr><td class="paramname">FAIL</td><td>on error </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00519.html#gaf6b6b0a641180a5c28382df39cd7d346" title="Add a parameter to a remote procedure call. ">dbrpcparam()</a>, <a class="el" href="a00519.html#gafa4dfd181be21e49c397f7daaa9cf96c" title="Execute the procedure and free associated memory. ">dbrpcsend()</a> </dd></dl>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="a00519_ga5b4374c13c7a83cd4345b0bfa3e787bd_cgraph.svg" width="236" height="38"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
<a id="gaf6b6b0a641180a5c28382df39cd7d346"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf6b6b0a641180a5c28382df39cd7d346">§ </a></span>dbrpcparam()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RETCODE dbrpcparam </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00901.html">DBPROCESS</a> * </td>
<td class="paramname"><em>dbproc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char </td>
<td class="paramname"><em>paramname</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">BYTE </td>
<td class="paramname"><em>status</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>db_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">DBINT </td>
<td class="paramname"><em>maxlen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">DBINT </td>
<td class="paramname"><em>datalen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">BYTE * </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a parameter to a remote procedure call. </p>
<p>Call between <a class="el" href="a00519.html#ga5b4374c13c7a83cd4345b0bfa3e787bd" title="Initialize a remote procedure call. ">dbrpcinit()</a> and <a class="el" href="a00519.html#gafa4dfd181be21e49c397f7daaa9cf96c" title="Execute the procedure and free associated memory. ">dbrpcsend()</a> </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dbproc</td><td>contains all information needed by db-lib to manage communications with the server. </td></tr>
<tr><td class="paramname">paramname</td><td>literal name of the parameter, according to the stored procedure (starts with '@'). Optional. If not used, parameters will be passed in order instead of by name. </td></tr>
<tr><td class="paramname">status</td><td>must be DBRPCRETURN, if this parameter is a return parameter, else 0. </td></tr>
<tr><td class="paramname">type</td><td>datatype of the value parameter e.g., SYBINT4, SYBCHAR. </td></tr>
<tr><td class="paramname">maxlen</td><td>Maximum output size of the parameter's value to be returned by the stored procedure, usually the size of your host variable. Fixed-length datatypes take -1 (NULL or not). Non-OUTPUT parameters also use -1. Use 0 to send a NULL value for a variable length datatype. </td></tr>
<tr><td class="paramname">datalen</td><td>For variable-length datatypes, the byte size of the data to be sent, exclusive of any null terminator. For fixed-length datatypes use -1. To send a NULL value, use 0. </td></tr>
<tr><td class="paramname">value</td><td>Address of your host variable. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">SUCCEED</td><td>normal. </td></tr>
<tr><td class="paramname">FAIL</td><td>on error </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00519.html#ga5b4374c13c7a83cd4345b0bfa3e787bd" title="Initialize a remote procedure call. ">dbrpcinit()</a>, <a class="el" href="a00519.html#gafa4dfd181be21e49c397f7daaa9cf96c" title="Execute the procedure and free associated memory. ">dbrpcsend()</a> </dd></dl>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="a00519_gaf6b6b0a641180a5c28382df39cd7d346_cgraph.svg" width="259" height="38"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
<a id="gafa4dfd181be21e49c397f7daaa9cf96c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafa4dfd181be21e49c397f7daaa9cf96c">§ </a></span>dbrpcsend()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RETCODE dbrpcsend </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00901.html">DBPROCESS</a> * </td>
<td class="paramname"><em>dbproc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Execute the procedure and free associated memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dbproc</td><td>contains all information needed by db-lib to manage communications with the server. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">SUCCEED</td><td>normal. </td></tr>
<tr><td class="paramname">FAIL</td><td>on error </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00519.html#ga5b4374c13c7a83cd4345b0bfa3e787bd" title="Initialize a remote procedure call. ">dbrpcinit()</a>, <a class="el" href="a00519.html#gaf6b6b0a641180a5c28382df39cd7d346" title="Add a parameter to a remote procedure call. ">dbrpcparam()</a> </dd></dl>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="a00519_gafa4dfd181be21e49c397f7daaa9cf96c_cgraph.svg" width="250" height="38"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</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>
