<!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 field information</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.msql-fetch-array.html">msql_fetch_array</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.msql-fetch-object.html">msql_fetch_object</a></div>
<div class="up"><a href="ref.msql.html">mSQL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.msql-fetch-field" class="refentry">
<div class="refnamediv">
<h1 class="refname">msql_fetch_field</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">msql_fetch_field</span> — <span class="dc-title">Get field information</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.msql-fetch-field-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">object</span> <span class="methodname"><strong>msql_fetch_field</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 class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>msql_fetch_field()</strong></span> can be used in order to obtain
information about fields in a certain query result.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.msql-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">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.msql-query.html" class="function">msql_query()</a></span>.</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">field_offset</code></em></span>
<dd>
<p class="para">
The field offset. If not specified, the next field that wasn't yet
retrieved by <span class="function"><strong>msql_fetch_field()</strong></span> is retrieved.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.msql-fetch-field-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an object containing field information. The properties of the
object are:
<ul class="itemizedlist">
<li class="listitem">
<p class="para">
<span class="property">name</span> - column name
</p>
</li>
<li class="listitem">
<p class="para">
<span class="property">table</span> - name of the table the column belongs to
</p>
</li>
<li class="listitem">
<p class="para">
<span class="property">not_null</span> - 1 if the column cannot be <strong><code>NULL</code></strong>
</p>
</li>
<li class="listitem">
<p class="para">
<span class="property">unique</span> - 1 if the column is a unique key
</p>
</li>
<li class="listitem">
<span class="simpara">
type - the type of the column
</span>
</li>
</ul>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.msql-fetch-field-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.msql-field-seek.html" class="function" rel="rdfs-seeAlso">msql_field_seek()</a> - Set 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="function.msql-fetch-array.html">msql_fetch_array</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.msql-fetch-object.html">msql_fetch_object</a></div>
<div class="up"><a href="ref.msql.html">mSQL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
