cubrid-move-cursor.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 648875cf73af01acdb6afaa5ca38b0bf6631bf42 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.cubrid-move-cursor" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>cubrid_move_cursor</refname>
  <refpurpose>Перемещает курсор в результате</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>cubrid_move_cursor</methodname>
   <methodparam><type>resource</type><parameter>req_identifier</parameter></methodparam>
   <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>origin</parameter><initializer>CUBRID_CURSOR_CURRENT</initializer></methodparam>
  </methodsynopsis>
  <para>
   Функция <function>cubrid_move_cursor</function> используется для перемещения
   текущего положения курсора <parameter>req_identifier</parameter> на значение, заданное
   в аргументе <parameter>offset</parameter>, в направлении, заданном
   в аргументе <parameter>origin</parameter>. Чтобы установить аргумент <parameter>origin</parameter>,
   вы можете использовать <constant>CUBRID_CURSOR_FIRST</constant> для первой части результата,
   <constant>CUBRID_CURSOR_CURRENT</constant> для текущего местоположения результата
   или <constant>CUBRID_CURSOR_LAST</constant> для последней части результата.
   Если аргумент <parameter>origin</parameter> не указан явно, тогда функция
   использует <constant>CUBRID_CURSOR_CURRENT</constant> в качестве значения по умолчанию.
  </para>
  <para>
   Если значение диапазона перемещения курсора превышает допустимый предел,
   то курсор перемещается в следующее место после допустимого диапазона для курсора.
   Например, если вы переместите 20 единиц в результате с размером 10,
   то курсор переместится на 11-е место и вернёт <constant>CUBRID_NO_MORE_DATA</constant>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term>
      <parameter>req_identifier</parameter>
     </term>
     <listitem>
      <para>
       Идентификатор запроса.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>offset</parameter>
     </term>
     <listitem>
      <para>
       Количество единиц, на которые нужно переместить курсор.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>origin</parameter>
     </term>
     <listitem>
      <para>
       Место, из которого вы хотите переместить курсор: <constant>CUBRID_CURSOR_FIRST</constant>,
       <constant>CUBRID_CURSOR_CURRENT</constant> или <constant>CUBRID_CURSOR_LAST</constant>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Пример использования <function>cubrid_move_cursor</function></title>
   <programlisting role="php">
<![CDATA[
<?php
$conn = cubrid_connect("127.0.0.1", 33000, "demodb", "dba");

$req = cubrid_execute($conn, "SELECT * FROM code");
cubrid_move_cursor($req, 1, CUBRID_CURSOR_LAST);

$result = cubrid_fetch_row($req);
var_dump($result);

cubrid_move_cursor($req, 1, CUBRID_CURSOR_FIRST);
$result = cubrid_fetch_row($req);
var_dump($result);

cubrid_move_cursor($req, 1, CUBRID_CURSOR_CURRENT);
$result = cubrid_fetch_row($req);
var_dump($result);

cubrid_close_request($req);
cubrid_disconnect($conn);
?>
]]>
   </programlisting>
&example.outputs;
    <screen>
<![CDATA[
array(2) {
  [0]=>
  string(1) "G"
  [1]=>
  string(4) "Gold"
}
array(2) {
  [0]=>
  string(1) "X"
  [1]=>
  string(5) "Mixed"
}
array(2) {
  [0]=>
  string(1) "M"
  [1]=>
  string(3) "Man"
}
]]>
   </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
-->