File: ingres-result-seek.xml

package info (click to toggle)
php-doc 20140201-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 74,084 kB
  • ctags: 4,040
  • sloc: xml: 998,137; php: 20,812; cpp: 500; sh: 177; makefile: 63; awk: 28
file content (137 lines) | stat: -rw-r--r-- 3,730 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 308228 $ -->
<refentry xml:id="function.ingres-result-seek" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ingres_result_seek</refname>
  <refpurpose>Set the row position before fetching data</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ingres_result_seek</methodname>
   <methodparam><type>resource</type><parameter>result</parameter></methodparam>
   <methodparam><type>int</type><parameter>position</parameter></methodparam>
  </methodsynopsis>
  <para>
   This function is used to position the cursor associated with the result
   resource before issuing a fetch.  If <link
   linkend="ini.ingres.array-index-start">ingres.array_index_start</link>
   is set to 0 then the first row is 0 else it is 1.
   <function>ingres_result_seek</function> can be used only with queries that
   make use of <link linkend="ini.ingres.scrollable">scrollable
   cursors</link>. It cannot be used with
   <function>ingres_unbuffered_query</function>.
  </para>

  <note>
   <title>Related Configurations</title>
   <para>
    See also the <link linkend="ini.ingres.scrollable">ingres.scrollable</link>
    and <link linkend="ini.ingres.array-index-start">ingres.array_index_start</link> directives in 
    <link linkend="ingres.configuration">Runtime Configuration</link>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>result</parameter></term>
     <listitem>
      <para>
       The result identifier for a query
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>position</parameter></term>
     <listitem>
      <para>
       The row to position the cursor on. If <link
       linkend="ini.ingres.array-index-start">ingres.array_index_start</link>
       is set to 0, then the first row is 0, else it is 1
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Position the cursor on the 3rd row</title>
    <programlisting role="php">
<![CDATA[
<?php

$result=ingres_query($link, "select * from airport where ap_ccode = 'ES' order by ap_place asc");

/* goto row 3 */
if (!ingres_result_seek($result, 3))
{
    echo ingres_errno() . " - " . ingres_error . "\n";
    die("i died");
}
else
{
    $airport = ingres_fetch_object ($result);
    {
        echo $airport->ap_iatacode . " - " .  $airport->ap_name . "\n";
    }
}

ingres_commit($link);

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ingres_query</function></member>
    <member><function>ingres_fetch_array</function></member>
    <member><function>ingres_fetch_assoc</function></member>
    <member><function>ingres_fetch_object</function></member>
    <member><function>ingres_fetch_row</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
-->