<!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.mssql-fetch-batch.html">mssql_fetch_batch</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mssql-fetch-object.html">mssql_fetch_object</a></div>
<div class="up"><a href="ref.mssql.html">Mssql Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.mssql-fetch-field" class="refentry">
<div class="refnamediv">
<h1 class="refname">mssql_fetch_field</h1>
<p class="verinfo">(PHP 4, PHP 5, PECL odbtp >= 1.1.1)</p><p class="refpurpose"><span class="refname">mssql_fetch_field</span> — <span class="dc-title">Get field information</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.mssql-fetch-field-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">object</span> <span class="methodname"><strong>mssql_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"> = -1</span></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>mssql_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.mssql-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 resource that is being evaluated. This result comes from a
call to <span class="function"><a href="function.mssql-query.html" class="function">mssql_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. If the field offset is not specified, the
next field that was not yet retrieved by this function is retrieved. The
<em><code class="parameter">field_offset</code></em> starts at 0.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.mssql-fetch-field-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an object containing field information.
</p>
<p class="para">
The properties of the object are:
</p>
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
name - column name. if the column is a result of a function,
this property is set to computed#N, where #N is a serial
number.
</span>
</li>
<li class="listitem">
<span class="simpara">
column_source - the table from which the column was taken
</span>
</li>
<li class="listitem">
<span class="simpara">
max_length - maximum length of the column
</span>
</li>
<li class="listitem">
<span class="simpara">
numeric - 1 if the column is numeric
</span>
</li>
<li class="listitem">
<span class="simpara">
type - the column type.
</span>
</li>
</ul>
</div>
<div class="refsect1 examples" id="refsect1-function.mssql-fetch-field-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-1530">
<p><strong>Example #1 <span class="function"><strong>mssql_fetch_field()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Connect to MSSQL and select the database<br /></span><span style="color: #0000BB">mssql_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'MANGO\SQLEXPRESS'</span><span style="color: #007700">, </span><span style="color: #DD0000">'sa'</span><span style="color: #007700">, </span><span style="color: #DD0000">'phpfi'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">mssql_select_db</span><span style="color: #007700">(</span><span style="color: #DD0000">'php'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Send a select query to MSSQL<br /></span><span style="color: #0000BB">$query </span><span style="color: #007700">= </span><span style="color: #0000BB">mssql_query</span><span style="color: #007700">(</span><span style="color: #DD0000">'SELECT * FROM [php].[dbo].[persons]'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Construct table<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">'<h3>Table structure for \'persons\'</h3>'</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">'<table border="1">'</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// Table header<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">'<thead>'</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">'<tr>'</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">'<td>Field name</td>'</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">'<td>Data type</td>'</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">'<td>Max length</td>'</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">'</tr>'</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">'</thead>'</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// Dump all fields<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">'<tbody>'</span><span style="color: #007700">;<br /><br />for (</span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">; </span><span style="color: #0000BB">$i </span><span style="color: #007700">< </span><span style="color: #0000BB">mssql_num_fields</span><span style="color: #007700">(</span><span style="color: #0000BB">$query</span><span style="color: #007700">); ++</span><span style="color: #0000BB">$i</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// Fetch the field information<br /> </span><span style="color: #0000BB">$field </span><span style="color: #007700">= </span><span style="color: #0000BB">mssql_fetch_field</span><span style="color: #007700">(</span><span style="color: #0000BB">$query</span><span style="color: #007700">, </span><span style="color: #0000BB">$i</span><span style="color: #007700">);<br /><br /> </span><span style="color: #FF8000">// Print the row<br /> </span><span style="color: #007700">echo </span><span style="color: #DD0000">'<tr>'</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">'<td>' </span><span style="color: #007700">. </span><span style="color: #0000BB">$field</span><span style="color: #007700">-></span><span style="color: #0000BB">name </span><span style="color: #007700">. </span><span style="color: #DD0000">'</td>'</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">'<td>' </span><span style="color: #007700">. </span><span style="color: #0000BB">strtoupper</span><span style="color: #007700">(</span><span style="color: #0000BB">$field</span><span style="color: #007700">-></span><span style="color: #0000BB">type</span><span style="color: #007700">) . </span><span style="color: #DD0000">'</td>'</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">'<td>' </span><span style="color: #007700">. </span><span style="color: #0000BB">$field</span><span style="color: #007700">-></span><span style="color: #0000BB">max_length </span><span style="color: #007700">. </span><span style="color: #DD0000">'</td>'</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">'</tr>'</span><span style="color: #007700">;<br />}<br /><br />echo </span><span style="color: #DD0000">'</tbody>'</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">'</table>'</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// Free the query result<br /></span><span style="color: #0000BB">mssql_free_result</span><span style="color: #007700">(</span><span style="color: #0000BB">$query</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.mssql-fetch-field-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.mssql-field-seek.html" class="function" rel="rdfs-seeAlso">mssql_field_seek()</a> - Seeks to the 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="function.mssql-fetch-batch.html">mssql_fetch_batch</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mssql-fetch-object.html">mssql_fetch_object</a></div>
<div class="up"><a href="ref.mssql.html">Mssql Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
