<!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>Returns the next field in the result set</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mysqli-result.fetch-field-direct.html">mysqli_result::fetch_field_direct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysqli-result.fetch-fields.html">mysqli_result::fetch_fields</a></div>
<div class="up"><a href="class.mysqli-result.html">mysqli_result</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mysqli-result.fetch-field" class="refentry">
<div class="refnamediv">
<h1 class="refname">mysqli_result::fetch_field</h1>
<h1 class="refname">mysqli_fetch_field</h1>
<p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">mysqli_result::fetch_field</span> -- <span class="refname">mysqli_fetch_field</span> — <span class="dc-title">Returns the next field in the result set</span></p>
</div>
<div class="refsect1 description" id="refsect1-mysqli-result.fetch-field-description">
<h3 class="title">Description</h3>
<p class="para">Object oriented style</p>
<div class="methodsynopsis dc-description">
<span class="type">object</span> <span class="methodname"><strong>mysqli_result::fetch_field</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">Procedural style</p>
<div class="methodsynopsis dc-description">
<span class="type">object</span> <span class="methodname"><strong>mysqli_fetch_field</strong></span>
( <span class="methodparam"><span class="type"><a href="class.mysqli-result.html" class="type mysqli_result">mysqli_result</a></span> <code class="parameter">$result</code></span>
)</div>
<p class="para rdfs-comment">
Returns the definition of one column of a result set as an object. Call
this function repeatedly to retrieve information about all columns in the
result set.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mysqli-result.fetch-field-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">Procedural style only: A result set
identifier returned by <span class="function"><a href="mysqli.query.html" class="function">mysqli_query()</a></span>, <span class="function"><a href="mysqli.store-result.html" class="function">mysqli_store_result()</a></span>
or <span class="function"><a href="mysqli.use-result.html" class="function">mysqli_use_result()</a></span>.</p></dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mysqli-result.fetch-field-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an object which contains field definition information or <strong><code>FALSE</code></strong>
if no field information is available.
</p>
<p class="para">
<table class="doctable table">
<caption><strong>Object properties</strong></caption>
<thead>
<tr>
<th>Property</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>name</td>
<td>The name of the column</td>
</tr>
<tr>
<td>orgname</td>
<td>Original column name if an alias was specified</td>
</tr>
<tr>
<td>table</td>
<td>The name of the table this field belongs to (if not calculated)</td>
</tr>
<tr>
<td>orgtable</td>
<td>Original table name if an alias was specified</td>
</tr>
<tr>
<td>def</td>
<td>Reserved for default value, currently always ""</td>
</tr>
<tr>
<td>db</td>
<td>Database (since PHP 5.3.6)</td>
</tr>
<tr>
<td>catalog</td>
<td>The catalog name, always "def" (since PHP 5.3.6)</td>
</tr>
<tr>
<td>max_length</td>
<td>The maximum width of the field for the result set.</td>
</tr>
<tr>
<td>length</td>
<td>The width of the field, as specified in the table definition.</td>
</tr>
<tr>
<td>charsetnr</td>
<td>The character set number for the field.</td>
</tr>
<tr>
<td>flags</td>
<td>An integer representing the bit-flags for the field.</td>
</tr>
<tr>
<td>type</td>
<td>The data type used for this field</td>
</tr>
<tr>
<td>decimals</td>
<td>The number of decimals used (for integer fields)</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-mysqli-result.fetch-field-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1734">
<p><strong>Example #1 Object oriented style</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$mysqli </span><span style="color: #007700">= new </span><span style="color: #0000BB">mysqli</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_user"</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_password"</span><span style="color: #007700">, </span><span style="color: #DD0000">"world"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* check connection */<br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">mysqli_connect_errno</span><span style="color: #007700">()) {<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Connect failed: %s\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">mysqli_connect_error</span><span style="color: #007700">());<br /> exit();<br />}<br /><br /></span><span style="color: #0000BB">$query </span><span style="color: #007700">= </span><span style="color: #DD0000">"SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5"</span><span style="color: #007700">;<br /><br />if (</span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$mysqli</span><span style="color: #007700">-></span><span style="color: #0000BB">query</span><span style="color: #007700">(</span><span style="color: #0000BB">$query</span><span style="color: #007700">)) {<br /><br /> </span><span style="color: #FF8000">/* Get field information for all columns */<br /> </span><span style="color: #007700">while (</span><span style="color: #0000BB">$finfo </span><span style="color: #007700">= </span><span style="color: #0000BB">$result</span><span style="color: #007700">-></span><span style="color: #0000BB">fetch_field</span><span style="color: #007700">()) {<br /><br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Name: %s\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">$finfo</span><span style="color: #007700">-></span><span style="color: #0000BB">name</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Table: %s\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">$finfo</span><span style="color: #007700">-></span><span style="color: #0000BB">table</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"max. Len: %d\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">$finfo</span><span style="color: #007700">-></span><span style="color: #0000BB">max_length</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Flags: %d\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">$finfo</span><span style="color: #007700">-></span><span style="color: #0000BB">flags</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Type: %d\n\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">$finfo</span><span style="color: #007700">-></span><span style="color: #0000BB">type</span><span style="color: #007700">);<br /> }<br /> </span><span style="color: #0000BB">$result</span><span style="color: #007700">-></span><span style="color: #0000BB">close</span><span style="color: #007700">();<br />}<br /><br /></span><span style="color: #FF8000">/* close connection */<br /></span><span style="color: #0000BB">$mysqli</span><span style="color: #007700">-></span><span style="color: #0000BB">close</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-1735">
<p><strong>Example #2 Procedural style</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$link </span><span style="color: #007700">= </span><span style="color: #0000BB">mysqli_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_user"</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_password"</span><span style="color: #007700">, </span><span style="color: #DD0000">"world"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* check connection */<br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">mysqli_connect_errno</span><span style="color: #007700">()) {<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Connect failed: %s\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">mysqli_connect_error</span><span style="color: #007700">());<br /> exit();<br />}<br /><br /></span><span style="color: #0000BB">$query </span><span style="color: #007700">= </span><span style="color: #DD0000">"SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5"</span><span style="color: #007700">;<br /><br />if (</span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">mysqli_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">, </span><span style="color: #0000BB">$query</span><span style="color: #007700">)) {<br /><br /> </span><span style="color: #FF8000">/* Get field information for all fields */<br /> </span><span style="color: #007700">while (</span><span style="color: #0000BB">$finfo </span><span style="color: #007700">= </span><span style="color: #0000BB">mysqli_fetch_field</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">)) {<br /><br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Name: %s\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">$finfo</span><span style="color: #007700">-></span><span style="color: #0000BB">name</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Table: %s\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">$finfo</span><span style="color: #007700">-></span><span style="color: #0000BB">table</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"max. Len: %d\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">$finfo</span><span style="color: #007700">-></span><span style="color: #0000BB">max_length</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Flags: %d\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">$finfo</span><span style="color: #007700">-></span><span style="color: #0000BB">flags</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Type: %d\n\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">$finfo</span><span style="color: #007700">-></span><span style="color: #0000BB">type</span><span style="color: #007700">);<br /> }<br /> </span><span style="color: #0000BB">mysqli_free_result</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #FF8000">/* close connection */<br /></span><span style="color: #0000BB">mysqli_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above examples will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Name: Name
Table: Country
max. Len: 11
Flags: 1
Type: 254
Name: SurfaceArea
Table: Country
max. Len: 10
Flags: 32769
Type: 4
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-mysqli-result.fetch-field-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="mysqli-result.field-count.html" class="function" rel="rdfs-seeAlso">mysqli_num_fields()</a> - Get the number of fields in a result</span></li>
<li class="member"> <span class="function"><a href="mysqli-result.fetch-field-direct.html" class="function" rel="rdfs-seeAlso">mysqli_fetch_field_direct()</a> - Fetch meta-data for a single field</span></li>
<li class="member"> <span class="function"><a href="mysqli-result.fetch-fields.html" class="function" rel="rdfs-seeAlso">mysqli_fetch_fields()</a> - Returns an array of objects representing the fields in a result set</span></li>
<li class="member"> <span class="function"><a href="mysqli-result.field-seek.html" class="function" rel="rdfs-seeAlso">mysqli_field_seek()</a> - Set result pointer to a specified field offset</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="mysqli-result.fetch-field-direct.html">mysqli_result::fetch_field_direct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysqli-result.fetch-fields.html">mysqli_result::fetch_fields</a></div>
<div class="up"><a href="class.mysqli-result.html">mysqli_result</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
