Source of: /manual/en/function.mssql-fetch-field.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.mssql.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.mssql-fetch-field.php',
1 => 'mssql_fetch_field',
),
'up' =>
array (
0 => 'ref.mssql.php',
1 => 'Mssql Functions',
),
'prev' =>
array (
0 => 'function.mssql-fetch-batch.php',
1 => 'mssql_fetch_batch',
),
'next' =>
array (
0 => 'function.mssql-fetch-object.php',
1 => 'mssql_fetch_object',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<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>
<a name="function.mssql-fetch-field.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">object</span> <span class="methodname"><b>mssql_fetch_field</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$result</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$field_offset</tt><span class="initializer"> = -1</span></span>
] )</div>
<p class="para rdfs-comment">
<b>mssql_fetch_field()</b> can be used in order to
obtain information about fields in a certain query result.
</p>
</div>
<a name="function.mssql-fetch-field.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">result</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The result resource that is being evaluated. This result comes from a
call to <a href="function.mssql-query.php" class="function">mssql_query()</a>.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">field_offset</tt></i>
</span>
</dt><dd class="listitem">
<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
<i><tt class="parameter">field_offset</tt></i>
starts at 0.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.mssql-fetch-field.returnvalues"></a><div class="refsect1 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>
<a name="function.mssql-fetch-field.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>mssql_fetch_field()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Connect MSSQL<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 />{<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>
</p>
</div>
<a name="function.mssql-fetch-field.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.mssql-field-seek.php" class="function" rel="rdfs-seeAlso">mssql_field_seek()</a> - Seeks to the specified field offset</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>