<!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>Retrieves metadata for the fields of a statement prepared by
sqlsrv_prepare or sqlsrv_query</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.sqlsrv-fetch.html">sqlsrv_fetch</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.sqlsrv-free-stmt.html">sqlsrv_free_stmt</a></div>
<div class="up"><a href="ref.sqlsrv.html">SQLSRV Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.sqlsrv-field-metadata" class="refentry">
<div class="refnamediv">
<h1 class="refname">sqlsrv_field_metadata</h1>
<p class="verinfo">(No version information available, might only be in SVN)</p><p class="refpurpose"><span class="refname">sqlsrv_field_metadata</span> — <span class="dc-title">Retrieves metadata for the fields of a statement prepared by
<span class="function"><a href="function.sqlsrv-prepare.html" class="function">sqlsrv_prepare()</a></span> or <span class="function"><a href="function.sqlsrv-query.html" class="function">sqlsrv_query()</a></span>
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.sqlsrv-field-metadata-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>sqlsrv_field_metadata</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$stmt</code></span>
)</div>
<p class="para rdfs-comment">
Retrieves metadata for the fields of a statement prepared by
<span class="function"><a href="function.sqlsrv-prepare.html" class="function">sqlsrv_prepare()</a></span> or <span class="function"><a href="function.sqlsrv-query.html" class="function">sqlsrv_query()</a></span>.
<span class="function"><strong>sqlsrv_field_metadata()</strong></span> can be called on a statement before
or after statement execution.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.sqlsrv-field-metadata-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">stmt</code></em></span>
<dd>
<p class="para">
The statment resource for which metadata is returned.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.sqlsrv-field-metadata-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array of arrays is returned on success. Otherwise, <strong><code>FALSE</code></strong> is returned.
Each returned array is described by the following table:
<table class="doctable table">
<caption><strong>Array returned by sqlsrv_field_metadata</strong></caption>
<thead>
<tr>
<th>Key</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>Name</td>
<td>The name of the field.</td>
</tr>
<tr>
<td>Type</td>
<td>The numeric value for the SQL type.</td>
</tr>
<tr>
<td>Size</td>
<td>The number of characters for fields of character type, the number of
bytes for fields of binary type, or <strong><code>NULL</code></strong> for other types.</td>
</tr>
<tr>
<td>Precision</td>
<td>The precision for types of variable precision, <strong><code>NULL</code></strong> for other types.</td>
</tr>
<tr>
<td>Scale</td>
<td>The scale for types of variable scale, <strong><code>NULL</code></strong> for other types.</td>
</tr>
<tr>
<td>Nullable</td>
<td>An enumeration indicating whether the column is nullable, not nullable,
or if it is not known.</td>
</tr>
</tbody>
</table>
For more information, see <a href="http://msdn.microsoft.com/en-us/library/cc296197.aspx" class="link external">» sqlsrv_field_metadata</a>
in the Microsoft SQLSRV documentation.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.sqlsrv-field-metadata-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2181">
<p><strong>Example #1 <span class="function"><strong>sqlsrv_field_metadata()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$serverName </span><span style="color: #007700">= </span><span style="color: #DD0000">"serverName\sqlexpress"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$connectionInfo </span><span style="color: #007700">= array( </span><span style="color: #DD0000">"Database"</span><span style="color: #007700">=></span><span style="color: #DD0000">"AdventureWorks"</span><span style="color: #007700">, </span><span style="color: #DD0000">"UID"</span><span style="color: #007700">=></span><span style="color: #DD0000">"username"</span><span style="color: #007700">, </span><span style="color: #DD0000">"PWD"</span><span style="color: #007700">=></span><span style="color: #DD0000">"password"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">sqlsrv_connect</span><span style="color: #007700">( </span><span style="color: #0000BB">$serverName</span><span style="color: #007700">, </span><span style="color: #0000BB">$connectionInfo</span><span style="color: #007700">);<br />if( </span><span style="color: #0000BB">$conn </span><span style="color: #007700">=== </span><span style="color: #0000BB">false </span><span style="color: #007700">) {<br /> die( </span><span style="color: #0000BB">print_r</span><span style="color: #007700">( </span><span style="color: #0000BB">sqlsrv_errors</span><span style="color: #007700">(), </span><span style="color: #0000BB">true</span><span style="color: #007700">));<br />}<br /><br /></span><span style="color: #0000BB">$sql </span><span style="color: #007700">= </span><span style="color: #DD0000">"SELECT * FROM Table_1"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$stmt </span><span style="color: #007700">= </span><span style="color: #0000BB">sqlsrv_prepare</span><span style="color: #007700">( </span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #0000BB">$sql </span><span style="color: #007700">);<br /><br />foreach( </span><span style="color: #0000BB">sqlsrv_field_metadata</span><span style="color: #007700">( </span><span style="color: #0000BB">$stmt </span><span style="color: #007700">) as </span><span style="color: #0000BB">$fieldMetadata </span><span style="color: #007700">) {<br /> foreach( </span><span style="color: #0000BB">$fieldMetadata </span><span style="color: #007700">as </span><span style="color: #0000BB">$name </span><span style="color: #007700">=> </span><span style="color: #0000BB">$value</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$name</span><span style="color: #DD0000">: </span><span style="color: #0000BB">$value</span><span style="color: #DD0000"><br />"</span><span style="color: #007700">;<br /> }<br /> echo </span><span style="color: #DD0000">"<br />"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.sqlsrv-field-metadata-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.sqlsrv-client-info.html" class="function" rel="rdfs-seeAlso">sqlsrv_client_info()</a> - Returns information about the client and specified connection</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.sqlsrv-fetch.html">sqlsrv_fetch</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.sqlsrv-free-stmt.html">sqlsrv_free_stmt</a></div>
<div class="up"><a href="ref.sqlsrv.html">SQLSRV Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
