svn: /phpdoc/en/trunk/reference/cubrid/functions/ cubrid-lob-close.xml

From: Date: Tue, 11 Jan 2011 01:59:29 +0000
Subject: svn: /phpdoc/en/trunk/reference/cubrid/functions/ cubrid-lob-close.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-7636@lists.php.net to get a copy of this message
cubrid Tue, 11 Jan 2011 01:59:29 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=307361 Log: add documentation for cubrid_lob_close Changed paths: A phpdoc/en/trunk/reference/cubrid/functions/cubrid-lob-close.xml Added: phpdoc/en/trunk/reference/cubrid/functions/cubrid-lob-close.xml =================================================================== --- phpdoc/en/trunk/reference/cubrid/functions/cubrid-lob-close.xml (rev 0) +++ phpdoc/en/trunk/reference/cubrid/functions/cubrid-lob-close.xml 2011-01-11 01:59:29 UTC (rev 307361) @@ -0,0 +1,92 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 303158 $ --> + +<refentry xml:id="function.cubrid-lob-close" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>cubrid_lob_close</refname> + <refpurpose>Is used to close BLOB/CLOB</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>cubrid_lob_close</methodname> + <methodparam><type>array</type><parameter>lob_identifier_array</parameter></methodparam> + </methodsynopsis> + <para> + <function>cubrid_lob_close</function> is used to close all BLOB/CLOB returned from <function>cubrid_lob_get</function>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>lob_identifier_array</parameter></term> + <listitem><para>LOB identifier array return from cubrid_lob_get.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &true;, when process is successful. + </para> + <para> + &false;, when process is unsuccessful. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <example> + <title><function>cubrid_lob_close</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +$lobs = cubrid_lob_get($con, "SELECT doc_content FROM doc WHERE doc_id=5"); +cubrid_lob_export($conn, $lobs[0], "doc_5.txt"); +cubrid_lob_close($lobs); +?> +]]> + </programlisting> + </example> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>cubrid_lob_get</function></member> + <member><function>cubrid_lob_size</function></member> + <member><function>cubrid_lob_export</function></member> + <member><function>cubrid_lob_send</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 +-->

« previous php.doc.cvs (#7636) next »