mysql-field-name.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b95d28e6ec86e4a71e012737d36ebdc1cf009180 Maintainer: HonestQiao Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<refentry xml:id="function.mysql-field-name" xmlns="http://docbook.org/ns/docbook">
   <refnamediv>
    <refname>mysql_field_name</refname>
    <refpurpose>
     取得结果中指定字段的字段名
    </refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <warning>
   &mysql.alternative.note;
   <simplelist role="alternatives">
    <member><function>mysqli_fetch_field_direct</function> [name] or [orgname]</member>
    <member><methodname>PDOStatement::getColumnMeta</methodname> [name]</member>
   </simplelist>
  </warning>
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>mysql_field_name</methodname>
   <methodparam><type>resource</type><parameter>result</parameter></methodparam>
   <methodparam><type>int</type><parameter>field_offset</parameter></methodparam>
  </methodsynopsis>
    <para>
     <function>mysql_field_name</function>
     返回指定字段索引的字段名。<parameter>result</parameter>
     必须是一个合法的结果标识符，<parameter>field_index</parameter>
     是该字段的数字偏移量。
    </para>
    <note>
     <para>
      <parameter>field_index</parameter> 从 0 开始。
     </para>
     <para>
      例如，第三个字段的索引值其实是 2，第四个字段的索引值是 3，以此类推。
     </para>
    </note>
    &database.field-case;
    <para>
     <example>
      <title><function>mysql_field_name</function> 例子</title>
      <programlisting role="php">
<![CDATA[
<?php
/* The users table consists of three fields:
 *   user_id
 *   username
 *   password.
 */
$link = mysql_connect('localhost', "mysql_user", "mysql_password");
$dbname = "mydb";
mysql_select_db($dbname, $link)
    or die("Could not set $dbname: " . mysql_error());
$res = mysql_query("select * from users", $link);

echo mysql_field_name($res, 0) . "\n";
echo mysql_field_name($res, 2);
?>
]]>
      </programlisting>
      <para>
       以上例子将产生如下输出：
      </para>
      <screen>
<![CDATA[
user_id
password
]]>
      </screen>
     </example>
    </para>
    <para>
     为向下兼容仍然可以使用 <function>mysql_fieldname</function>，但反对这样做。
    </para>
   </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &mysql.result.description;
    &mysql.field-offset.req.description;
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The name of the specified field index on success&return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>mysql_field_name</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
/* The users table consists of three fields:
 *   user_id
 *   username
 *   password.
 */
$link = mysql_connect('localhost', 'mysql_user', 'mysql_password');
if (!$link) {
    die('Could not connect to MySQL server: ' . mysql_error());
}
$dbname = 'mydb';
$db_selected = mysql_select_db($dbname, $link);
if (!$db_selected) {
    die("Could not set $dbname: " . mysql_error());
}
$res = mysql_query('select * from users', $link);

echo mysql_field_name($res, 0) . "\n";
echo mysql_field_name($res, 2);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
user_id
password
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &database.field-case;
  <note>
   <para>
    &info.deprecated.alias;
    <function>mysql_fieldname</function>
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mysql_field_type</function></member>
    <member><function>mysql_field_len</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
-->