mysql-field-flags.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mysql-field-flags" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mysql_field_flags</refname>
  <refpurpose>Get the flags associated with the specified field in a result</refpurpose>
 </refnamediv>

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

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>mysql_field_flags</methodname>
   <methodparam><type>resource</type><parameter>result</parameter></methodparam>
   <methodparam><type>int</type><parameter>field_offset</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>mysql_field_flags</function> returns the field flags of
   the specified field. The flags are reported as a single word
   per flag separated by a single space, so that you can split the
   returned value using <function>explode</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>
   Returns a string of flags associated with the result&return.falseforfailure;.
  </para>
  <para>
   The following flags are reported, if your version of MySQL
   is current enough to support them: <literal>"not_null"</literal>, 
   <literal>"primary_key"</literal>, <literal>"unique_key"</literal>, 
   <literal>"multiple_key"</literal>, <literal>"blob"</literal>, 
   <literal>"unsigned"</literal>, <literal>"zerofill"</literal>,
   <literal>"binary"</literal>, <literal>"enum"</literal>, 
   <literal>"auto_increment"</literal> and <literal>"timestamp"</literal>.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>mysql_field_flags</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$result = mysql_query("SELECT id,email FROM people WHERE id = '42'");
if (!$result) {
    echo 'Could not run query: ' . mysql_error();
    exit;
}
$flags = mysql_field_flags($result, 0);

echo $flags;
print_r(explode(' ', $flags));
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
not_null primary_key auto_increment
Array
(
    [0] => not_null
    [1] => primary_key
    [2] => auto_increment
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    &info.deprecated.alias;
    <function>mysql_fieldflags</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
-->