cvs: phpdoc /en/functions fbsql.xml

fmk Wed Oct 10 12:46:50 2001 EDT Modified files: /phpdoc/en/functions fbsql.xml Log: Documentation for create_blob and create_clob Index: phpdoc/en/functions/fbsql.xml diff -u phpdoc/en/functions/fbsql.xml:1.25 phpdoc/en/functions/fbsql.xml:1.26 --- phpdoc/en/functions/fbsql.xml:1.25 Sun Sep 23 16:14:59 2001 +++ phpdoc/en/functions/fbsql.xml Wed Oct 10 12:46:50 2001 @@ -1,5 +1,5 @@ <?xml encoding="iso-8859-1"?> -<!-- $Revision: 1.25 $ --> +<!-- $Revision: 1.26 $ --> <reference id="ref.fbsql"> <title>FrontBase functions</title> <titleabbrev>FrontBase</titleabbrev> @@ -350,6 +350,106 @@ </example> <para> See also: <function>fbsql_drop_db</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.fbsql-create-blob"> + <refnamediv> + <refname>fbsql_create_blob</refname> + <refpurpose>Create a BLOB</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>resource <function>fbsql_create_blob</function></funcdef> + <paramdef>string <parameter>blob_data</parameter></paramdef> + <paramdef>resource + <parameter> + <optional>link_identifier</optional> + </parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + Returns: A resource handle to the newly created blob. + </para> + <para> + <function>fbsql_create_blob</function> creates a blob from blob_data. + The returned resource handle can be used with insert and update commands + to store the blob in the database. + </para> + <example> + <title><function>fbsql_create_blob</function> example</title> + <programlisting role="php"> +&lt;?php + $link = fbsql_pconnect ("localhost", "_SYSTEM", "secret") + or die ("Could not connect"); + $filename = "blobfile.bin"; + $fp = fopen($filename, "rb"); + $blobdata = fread($fp, file_size($filename)); + fclose($fp); + + $blobHandle = fbsql_create_blob($blobdata, $link); + + $sql = "INSERT INTO BLOB_TABLE (BLOB_COLUMN) VALUES ($blobHandle);"; + $rs = fbsql_query($sql, $link); +?&gt; + </programlisting> + </example> + <para> + See also: <function>fbsql_create_clob</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.fbsql-create-clob"> + <refnamediv> + <refname>fbsql_create_clob</refname> + <refpurpose>Create a CLOB</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>resource <function>fbsql_create_clob</function></funcdef> + <paramdef>string <parameter>clob_data</parameter></paramdef> + <paramdef>resource + <parameter> + <optional>link_identifier</optional> + </parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + Returns: A resource handle to the newly created CLOB. + </para> + <para> + <function>fbsql_create_clob</function> creates a clob from clob_data. + The returned resource handle can be used with insert and update commands + to store the clob in the database. + </para> + <example> + <title><function>fbsql_create_clob</function> example</title> + <programlisting role="php"> +&lt;?php + $link = fbsql_pconnect ("localhost", "_SYSTEM", "secret") + or die ("Could not connect"); + $filename = "clob_file.txt"; + $fp = fopen($filename, "rb"); + $clobdata = fread($fp, file_size($filename)); + fclose($fp); + + $clobHandle = fbsql_create_clob($clobdata, $link); + + $sql = "INSERT INTO CLOB_TABLE (CLOB_COLUMN) VALUES ($clobHandle);"; + $rs = fbsql_query($sql, $link); +?&gt; + </programlisting> + </example> + <para> + See also: <function>fbsql_create_blob</function>. </para> </refsect1> </refentry>