cubrid-current-oid.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="function.cubrid-current-oid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>cubrid_current_oid</refname>
  <refpurpose>Get OID of the current cursor location</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>cubrid_current_oid</methodname>
   <methodparam><type>resource</type><parameter>req_identifier</parameter></methodparam>
  </methodsynopsis>
  <para>
    The <function>cubrid_current_oid</function> function is used to get the
    oid of the current cursor location from the query result.  To use
    <function>cubrid_current_oid</function>, the query executed must be a
    updatable query, and the <constant>CUBRID_INCLUDE_OID</constant> option must be included during
    the 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>
  </variablelist>
  </para>
 </refsect1>

  <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
    Oid of current cursor location, when process is successful,&return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>cubrid_current_oid</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
$conn = cubrid_connect("localhost", 33000, "demodb", "dba");

$req = cubrid_execute($conn, "SELECT * FROM code", CUBRID_INCLUDE_OID);
$oid = cubrid_current_oid($req);
$res = cubrid_get($conn, $oid);

print_r($res);

cubrid_disconnect($conn);
?>
]]>
   </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [s_name] => X
    [f_name] => Mixed
)
]]>
   </screen>

  </example>
 </refsect1>

    <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
   <member><function>cubrid_execute</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
-->