<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Get the flags associated with the specified field in a result</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mysql-fetch-row.html">mysql_fetch_row</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mysql-field-len.html">mysql_field_len</a></div>
<div class="up"><a href="ref.mysql.html">MySQL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.mysql-field-flags" class="refentry">
<div class="refnamediv">
<h1 class="refname">mysql_field_flags</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">mysql_field_flags</span> — <span class="dc-title">Get the flags associated with the specified field in a result</span></p>
</div>
<div id="function.mysql-field-flags-refsynopsisdiv">
<div class="warning"><strong class="warning">Warning</strong>
<p class="para">This extension is deprecated as of PHP 5.5.0, and will be removed in the future.
Instead, the <a href="book.mysqli.html" class="link">MySQLi</a> or <a href="ref.pdo-mysql.html" class="link">PDO_MySQL</a> extension should be used.
See also <a href="mysqlinfo.api.choosing.html" class="link">MySQL: choosing an API</a> guide and
<a href="faq.databases.html#faq.databases.mysql.deprecated" class="link">related FAQ</a> for more information.
Alternatives to this function include:</p>
<ul class="simplelist">
<li class="member"> <span class="function"><a href="mysqli-result.fetch-field-direct.html" class="function">mysqli_fetch_field_direct()</a></span> [flags]</li>
<li class="member"> <span class="methodname"><a href="pdostatement.getcolumnmeta.html" class="methodname">PDOStatement::getColumnMeta()</a></span> [flags]</li>
</ul>
</div>
</div>
<div class="refsect1 description" id="refsect1-function.mysql-field-flags-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>mysql_field_flags</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$result</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$field_offset</code></span>
)</div>
<p class="para rdfs-comment">
<span class="function"><strong>mysql_field_flags()</strong></span> 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 <span class="function"><a href="function.explode.html" class="function">explode()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.mysql-field-flags-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">
result</code></em></span><dd>
<p class="para">The result <span class="type"><a href="language.types.resource.html" class="type resource">resource</a></span> that
is being evaluated. This result comes from a call to
<span class="function"><a href="function.mysql-query.html" class="function">mysql_query()</a></span>.</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">
field_offset</code></em></span><dd>
<p class="para">The numerical field offset. The
<em><code class="parameter">field_offset</code></em> starts at <em>0</em>. If
<em><code class="parameter">field_offset</code></em> does not exist, an error of level
<strong><code>E_WARNING</code></strong> is also issued.</p></dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.mysql-field-flags-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a string of flags associated with the result or <strong><code>FALSE</code></strong> on failure.
</p>
<p class="para">
The following flags are reported, if your version of MySQL
is current enough to support them: <em>"not_null"</em>,
<em>"primary_key"</em>, <em>"unique_key"</em>,
<em>"multiple_key"</em>, <em>"blob"</em>,
<em>"unsigned"</em>, <em>"zerofill"</em>,
<em>"binary"</em>, <em>"enum"</em>,
<em>"auto_increment"</em> and <em>"timestamp"</em>.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.mysql-field-flags-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-1589">
<p><strong>Example #1 A <span class="function"><strong>mysql_field_flags()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$result </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_query</span><span style="color: #007700">(</span><span style="color: #DD0000">"SELECT id,email FROM people WHERE id = '42'"</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">$result</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">'Could not run query: ' </span><span style="color: #007700">. </span><span style="color: #0000BB">mysql_error</span><span style="color: #007700">();<br /> exit;<br />}<br /></span><span style="color: #0000BB">$flags </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_field_flags</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">$flags</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">explode</span><span style="color: #007700">(</span><span style="color: #DD0000">' '</span><span style="color: #007700">, </span><span style="color: #0000BB">$flags</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
not_null primary_key auto_increment
Array
(
[0] => not_null
[1] => primary_key
[2] => auto_increment
)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.mysql-field-flags-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
For backward compatibility, the following
deprecated alias may be used:
<span class="function"><strong>mysql_fieldflags()</strong></span>
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.mysql-field-flags-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.mysql-field-type.html" class="function" rel="rdfs-seeAlso">mysql_field_type()</a> - Get the type of the specified field in a result</span></li>
<li class="member"> <span class="function"><a href="function.mysql-field-len.html" class="function" rel="rdfs-seeAlso">mysql_field_len()</a> - Returns the length of the specified field</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mysql-fetch-row.html">mysql_fetch_row</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mysql-field-len.html">mysql_field_len</a></div>
<div class="up"><a href="ref.mysql.html">MySQL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
