php-doc-en/reference/mssql/functions/mssql-free-statement.xml
Kalle Sommer Nielsen 8270283d6b News
* Added missing <literal> on setup note
* Added a reference to PDO_DBLIB and PDO_ODBC on setup note
* Added a source comment on mssql_connect() explaining how to use a connect with a custom port
* Added undocumented ini setting mssql.charset (available as of PHP 5.1.2)
* Added missing parameter descriptions on mssql_guid_string
* Added missing examples for
 * mssql_data_seek (Ross)
 * mssql_execute
 * mssql_fetch_array
 * mssql_fetch_assoc
 * mssql_fetch_field
 * mssql_fetch_object
 * mssql_fetch_row (RMLR)
 * mssql_field_length
 * mssql_field_name
 * mssql_field_seek
 * mssql_field_type
 * mssql_free_result
 * mssql_free_statement
 * mssql_get_last_message
 * mssql_guid_string
 * mssql_init
 * mssql_min_error_severity
 * mssql_min_message_severity
 * mssql_num_fields
 * mssql_pconnect (RMLR)
 * mssql_result
* Added constant descriptions
* Documented the following functions
 * mssql_get_last_message
 * mssql_min_error_severity
 * mssql_min_message_severity
* Changed examples on the following
 * mssql_bind
 * mssql_fetch_batch
 * mssql_next_result
 * mssql_query
* Fixed example on mssql_rows_affected


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@267081 c90b9560-bf6c-de11-be94-00142212c4b1
2008-10-08 18:29:23 +00:00

104 lines
2.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mssql-free-statement" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mssql_free_statement</refname>
<refpurpose>Free statement memory</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mssql_free_statement</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>
<function>mssql_free_statement</function> 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 <function>mssql_free_statement</function>
with the statement identifier as an argument and the associated
statement memory will be freed.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stmt</parameter></term>
<listitem>
<para>
Statement resource, obtained with <function>mssql_init</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>mssql_free_statement</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Create a new statement
$stmt = mssql_init('test');
// Bind values here and execute statement
// once we're done, we clear it from the memory
// using mssql_free_statement like so:
mssql_free_statement($stmt);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mssql_bind</function></member>
<member><function>mssql_execute</function></member>
<member><function>mssql_init</function></member>
<member><function>mssql_free_result</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->