<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Execute TCL code on server side</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.dbplus-sql.html">dbplus_sql</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.dbplus-tremove.html">dbplus_tremove</a></div>
<div class="up"><a href="ref.dbplus.html">DB++ Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.dbplus-tcl" class="refentry">
<div class="refnamediv">
<h1 class="refname">dbplus_tcl</h1>
<p class="verinfo">(PHP 4 <= 4.1.0, PECL dbplus >= 0.9)</p><p class="refpurpose"><span class="refname">dbplus_tcl</span> — <span class="dc-title">Execute TCL code on server side</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.dbplus-tcl-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>dbplus_tcl</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$sid</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$script</code></span>
)</div>
<p class="para rdfs-comment">
A db++ server will prepare a TCL interpreter for each client
connection. This interpreter will enable the server to execute
TCL code provided by the client as a sort of stored procedures to
improve the performance of database operations by avoiding
client/server data transfers and context switches.
</p>
<p class="para">
<span class="function"><strong>dbplus_tcl()</strong></span> needs to pass the client
connection id the TCL <em><code class="parameter">script</code></em> code should
be executed by. <span class="function"><a href="function.dbplus-resolve.html" class="function">dbplus_resolve()</a></span> will provide
this connection id. The function will return whatever the TCL
code returns or a TCL error message if the TCL code fails.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.dbplus-tcl-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">sid</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">script</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.dbplus-tcl-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.dbplus-tcl-notes">
<h3 class="title">Notes</h3>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
<em class="emphasis">EXPERIMENTAL</em>. The behaviour of this function, its name, and
surrounding documentation may change without notice in a future release of PHP.
This function should be used at your own risk.
</p></div>
</div>
<div class="refsect1 seealso" id="refsect1-function.dbplus-tcl-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.dbplus-resolve.html" class="function" rel="rdfs-seeAlso">dbplus_resolve()</a> - Resolve host information for relation</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.dbplus-sql.html">dbplus_sql</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.dbplus-tremove.html">dbplus_tremove</a></div>
<div class="up"><a href="ref.dbplus.html">DB++ Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
