cvs: phpdoc /en/functions uodbc.xml

torben Tue Feb 12 16:12:23 2002 EDT Modified files: /phpdoc/en/functions uodbc.xml Log: Added documentation for odbc_execute()'s file reading functionality. Index: phpdoc/en/functions/uodbc.xml diff -u phpdoc/en/functions/uodbc.xml:1.30 phpdoc/en/functions/uodbc.xml:1.31 --- phpdoc/en/functions/uodbc.xml:1.30 Sat Feb 2 10:36:10 2002 +++ phpdoc/en/functions/uodbc.xml Tue Feb 12 16:12:22 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.30 $ --> +<!-- $Revision: 1.31 $ --> <reference id="ref.odbc"> <title>Unified ODBC functions</title> <titleabbrev>ODBC</titleabbrev> @@ -451,12 +451,53 @@ </methodsynopsis> <para> Executes a statement prepared with - <function>odbc_prepare</function>. Returns - &true; on successful execution, - &false; otherwise. The array - <parameter>parameters_array</parameter> only needs to - be given if you really have parameters in your statement. - </para> + <function>odbc_prepare</function>. Returns &true; on successful + execution; &false; otherwise. The array + <parameter>parameters_array</parameter> only needs to be given if + you really have parameters in your statement. + </para> + <para> + Parameters in <parameter>parameter_array</parameter> will be + substituted for placeholders in the prepared statement in order. + </para> + <para> + Any parameters in <parameter>parameter_array</parameter> which + start and end with single quotes will be taken as the name of a + file to read and send to the database server as the data for the + appropriate placeholder. + </para> + <note> + <para> + As of PHP 4.1.1, this file reading functionality has the + following restrictions: + <itemizedlist> + <listitem> + <simpara> + File reading is <emphasis>not</emphasis> subject to any <link + linkend="features.safe-mode">safe mode</link> restrictions. + </simpara> + </listitem> + <listitem> + <simpara> + <link linkend="features.remote-files">Remote files</link> + are not supported. + </simpara> + </listitem> + <listitem> + <simpara> + If you wish to store a string which actually begins and ends + with single quotes, and you cannot escape them with + backslashes--for instance, if your server requires single + quotes to be escaped by doubling them (<literal>''</literal>) + instead of backslashing them (<literal>\'</literal>)--then + you must use another mechanism to store them (such as + executing the query directly with + <function>odbc_exec</function>). + </simpara> + </listitem> + </itemizedlist> + </para> + </note> </refsect1> </refentry>