From d10aa47f6cbdb8c00b559726eb1595c18168e9f8 Mon Sep 17 00:00:00 2001
From: Esen Sagynov <cubrid@php.net>
Date: Fri, 11 Nov 2011 07:05:15 +0000
Subject: [PATCH] Added functions/cubrid-set-query-timeout.xml and
 functions/cubrid-get-query-timeout.xml

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@319033 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../functions/cubrid-get-query-timeout.xml    | 73 +++++++++++++++++
 .../functions/cubrid-set-query-timeout.xml    | 80 +++++++++++++++++++
 2 files changed, 153 insertions(+)
 create mode 100644 reference/cubrid/functions/cubrid-get-query-timeout.xml
 create mode 100644 reference/cubrid/functions/cubrid-set-query-timeout.xml

diff --git a/reference/cubrid/functions/cubrid-get-query-timeout.xml b/reference/cubrid/functions/cubrid-get-query-timeout.xml
new file mode 100644
index 0000000000..20c660562b
--- /dev/null
+++ b/reference/cubrid/functions/cubrid-get-query-timeout.xml
@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 317663 $ -->
+
+<refentry xml:id="function.cubrid-get-query-timeout" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>cubrid_get_query_timeout</refname>
+  <refpurpose>Get the query timeout value of the request</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>int</type><methodname>cubrid_get_query_timeout</methodname>
+   <methodparam><type>resource</type><parameter>req_identifier</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   The <function>cubrid_get_query_timeout</function> function is used to get
+   the query timeout of the request.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+  <variablelist>
+    <varlistentry>
+  <term><parameter>req_identifier</parameter></term>
+  <listitem><para>Request identifier.</para></listitem>
+   </varlistentry>
+  </variablelist>
+  </para>
+ </refsect1>
+
+  <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Success: the query timeout value of the current request. Units of msec.
+  </para>
+  <para>
+   Failure: FALSE
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+   <member><function>cubrid_set_query_timeout</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
+-->
diff --git a/reference/cubrid/functions/cubrid-set-query-timeout.xml b/reference/cubrid/functions/cubrid-set-query-timeout.xml
new file mode 100644
index 0000000000..fb0f914d8d
--- /dev/null
+++ b/reference/cubrid/functions/cubrid-set-query-timeout.xml
@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 317663 $ -->
+
+<refentry xml:id="function.cubrid-set-query-timeout" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>cubrid_set_query_timeout</refname>
+  <refpurpose>Set the timeout time of query execution</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>cubrid_set_autocommit</methodname>
+   <methodparam><type>resource</type><parameter>req_identifier</parameter></methodparam>
+   <methodparam><type>int</type><parameter>timeout</parameter></methodparam>  
+  </methodsynopsis>
+  <para>
+   The <function>cubrid_set_query_timeout</function> function is used to set
+   the timeout time of query execution.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+  <variablelist>
+   <varlistentry>
+    <term><parameter>req_identifier</parameter></term>
+    <listitem><para>Request identifier.</para></listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>timeout</parameter></term>
+    <listitem>
+     <para>Timeout time, unit of msec.</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="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+   <member><function>cubrid_get_query_timeout</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
+-->