php-doc-en/reference/mysqli/functions/mysqli-field-seek.xml
Georg Richter 8190ee59a5 little docu update
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@150059 c90b9560-bf6c-de11-be94-00142212c4b1
2004-01-28 23:18:42 +00:00

63 lines
1.9 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.mysqli-field-seek">
<refnamediv>
<refname>mysqli_field_seek</refname>
<refname>result->field_seek</refname>
<refpurpose>
Set result pointer to a specified field offset
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_field_seek</methodname>
<methodparam><type>object</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>fieldnr</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>result</classname></ooclass>
<methodsynopsis>
<type>int</type>
<methodname>field_seek</methodname>
<methodparam><type>int</type><parameter>fieldnr</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Sets the field cursor to the given offset. The next call to <function>mysqli_fetch_field</function>
will retrieve the field definition of the column associated with that offset.
</para>
<note>
<para>To seek to the beginning of a row, pass an offset value of zero.</para>
</note>
</refsect1>
<refsect1>
<title>Return values</title>
<para>
<function>mysqli_field_seek</function> returns previuos value of field cursor.
</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
-->