php-doc-en/reference/dbplus/functions/dbplus-tcl.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

95 lines
2.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.dbplus-tcl" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>dbplus_tcl</refname>
<refpurpose>Execute TCL code on server side</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>dbplus_tcl</methodname>
<methodparam><type>int</type><parameter>sid</parameter></methodparam>
<methodparam><type>string</type><parameter>script</parameter></methodparam>
</methodsynopsis>
<para>
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.
</para>
<para>
<function>dbplus_tcl</function> needs to pass the client
connection id the TCL <parameter>script</parameter> code should
be executed by. <function>dbplus_resolve</function> will provide
this connection id. The function will return whatever the TCL
code returns or a TCL error message if the TCL code fails.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>sid</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>script</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>dbplus_resolve</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->