php-doc-en/reference/maxdb/functions/maxdb-data-seek.xml
2008-06-04 08:44:35 +00:00

154 lines
3.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.maxdb-data-seek">
<refnamediv>
<refname>maxdb_data_seek</refname>
<refname>result->data_seek</refname>
<refpurpose>Adjusts the result pointer to an arbitary row in the result</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_data_seek</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>result</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>data_seek</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
The <function>maxdb_data_seek</function> function seeks to an arbitrary result pointer
specified by the <parameter>offset</parameter> in the result set represented by
<parameter>result</parameter>. The <parameter>offset</parameter> parameter must be between
zero and the total number of rows minus one (0..<function>maxdb_num_rows</function> - 1).
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
<![CDATA[
<?php
/* Open a connection */
$maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB");
/* check connection */
if (maxdb_connect_errno()) {
printf("Connect failed: %s\n", maxdb_connect_error());
exit();
}
$query = "SELECT name, state FROM hotel.city ORDER BY name";
if ($result = $maxdb->query( $query)) {
/* seek to row no. 10 */
$result->data_seek(10);
/* fetch row */
$row = $result->fetch_row();
printf ("City: %s State: %s\n", $row[0], $row[1]);
/* free result set*/
$result->close();
}
/* close connection */
$maxdb->close();
?>
]]>
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role="php">
<![CDATA[
<?php
$link = maxdb_connect("localhost", "MONA", "RED", "DEMODB");
/* check connection */
if (!$link) {
printf("Connect failed: %s\n", maxdb_connect_error());
exit();
}
$query = "SELECT name, state FROM hotel.city ORDER BY name";
if ($result = maxdb_query($link, $query)) {
/* seek to row no. 400 */
maxdb_data_seek($result, 10);
/* fetch row */
$row = maxdb_fetch_row($result);
printf ("City: %s State: %s\n", $row[0], $row[1]);
/* free result set*/
maxdb_free_result($result);
}
/* close connection */
maxdb_close($link);
?>
]]>
</programlisting>
</example>
&example.outputs.similar;
<screen>
<![CDATA[
City: Irvine State: CA
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_store_result</function></member>
<member><function>maxdb_fetch_row</function></member>
<member><function>maxdb_num_rows</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:"../../../../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
-->