php-doc-en/reference/sqlite/functions/sqlite-field-name.xml
Jakub Vrana 0d604bbc9d Remove <classsynopsis> from methods and fields definitions
PhD uses this context for decisions about links and similar.
It also simplifies the XML

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322205 c90b9560-bf6c-de11-be94-00142212c4b1
2012-01-13 14:20:43 +00:00

86 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.sqlite-field-name" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>sqlite_field_name</refname>
<refname>SQLiteResult::fieldName</refname>
<refname>SQLiteUnbuffered::fieldName</refname>
<refpurpose>Returns the name of a particular field</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>sqlite_field_name</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>field_index</parameter></methodparam>
</methodsynopsis>
<para>&style.oop; (method):</para>
<methodsynopsis>
<type>string</type><methodname>SQLiteResult::fieldName</methodname>
<methodparam><type>int</type><parameter>field_index</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>string</type><methodname>SQLiteUnbuffered::fieldName</methodname>
<methodparam><type>int</type><parameter>field_index</parameter></methodparam>
</methodsynopsis>
<para>
Given the ordinal column number, <parameter>field_index</parameter>,
<function>sqlite_field_name</function> returns the name of that field in
the result set <parameter>result</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
The SQLite result resource. This parameter is not required when using
the object-oriented method.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field_index</parameter></term>
<listitem>
<para>
The ordinal column number in the result set.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the name of a field in an SQLite result set, given the ordinal
column number; &false; on error.
</para>
&sqlite.case-fold;
</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
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
-->