Source of: /manual/en/function.mssql-free-statement.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-free-statement.php',
1 => 'mssql_free_statement',
),
'up' =>
array (
0 => 'ref.mssql.php',
1 => 'Mssql Functions',
),
'prev' =>
array (
0 => 'function.mssql-free-result.php',
1 => 'mssql_free_result',
),
'next' =>
array (
0 => 'function.mssql-get-last-message.php',
1 => 'mssql_get_last_message',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.mssql-free-statement" class="refentry">
<div class="refnamediv">
<h1 class="refname">mssql_free_statement</h1>
<p class="verinfo">(PHP 4 >= 4.3.2, PHP 5, PECL odbtp >= 1.1.1)</p><p class="refpurpose"><span class="refname">mssql_free_statement</span> — <span class="dc-title">Free statement memory</span></p>
</div>
<a name="function.mssql-free-statement.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>mssql_free_statement</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$stmt</tt></span>
)</div>
<p class="para rdfs-comment">
<b>mssql_free_statement()</b> only needs to be called
if you are worried about using too much memory while your script
is running. All statement memory will automatically be freed when
the script ends. You may call <b>mssql_free_statement()</b>
with the statement identifier as an argument and the associated
statement memory will be freed.
</p>
</div>
<a name="function.mssql-free-statement.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">stmt</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Statement resource, obtained with <a href="function.mssql-init.php" class="function">mssql_init()</a>.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.mssql-free-statement.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.mssql-free-statement.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>mssql_free_statement()</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">// Create a new statement<br /></span><span style="color: #0000BB">$stmt </span><span style="color: #007700">= </span><span style="color: #0000BB">mssql_init</span><span style="color: #007700">(</span><span style="color: #DD0000">'test'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Bind values here and execute the statement<br /><br />// once we're done, we clear it from the memory<br />// using mssql_free_statement like so:<br /></span><span style="color: #0000BB">mssql_free_statement</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.mssql-free-statement.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-bind.php" class="function" rel="rdfs-seeAlso">mssql_bind()</a> - Adds a parameter to a stored procedure or a remote stored procedure</li>
<li class="member"><a href="function.mssql-execute.php" class="function" rel="rdfs-seeAlso">mssql_execute()</a> - Executes a stored procedure on a MS SQL server database</li>
<li class="member"><a href="function.mssql-init.php" class="function" rel="rdfs-seeAlso">mssql_init()</a> - Initializes a stored procedure or a remote stored procedure</li>
<li class="member"><a href="function.mssql-free-result.php" class="function" rel="rdfs-seeAlso">mssql_free_result()</a> - Free result memory</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
