From 5fe60620d9a1e23fbfe0d51a5181940a1d8c7244 Mon Sep 17 00:00:00 2001
From: Esen Sagynov <cubrid@php.net>
Date: Tue, 11 Jan 2011 01:59:29 +0000
Subject: [PATCH] add documentation for cubrid_lob_close

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@307361 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../cubrid/functions/cubrid-lob-close.xml     | 92 +++++++++++++++++++
 1 file changed, 92 insertions(+)
 create mode 100644 reference/cubrid/functions/cubrid-lob-close.xml

diff --git a/reference/cubrid/functions/cubrid-lob-close.xml b/reference/cubrid/functions/cubrid-lob-close.xml
new file mode 100644
index 0000000000..7bc982ebf6
--- /dev/null
+++ b/reference/cubrid/functions/cubrid-lob-close.xml
@@ -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
+-->