php-doc-en/reference/mssql/functions/mssql-free-result.xml
Adam Harvey e99d7aeee9 Add removal warnings to mssql.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338426 c90b9560-bf6c-de11-be94-00142212c4b1
2016-01-08 01:13:53 +00:00

111 lines
2.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mssql-free-result" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mssql_free_result</refname>
<refpurpose>Free result memory</refpurpose>
</refnamediv>
<refsynopsisdiv>
<warning>
&warn.removed.function.7-0-0.alternatives;
<simplelist role="alternatives">
<member><function>odbc_free_result</function></member>
</simplelist>
</warning>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mssql_free_result</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
<function>mssql_free_result</function> only needs to be called
if you are worried about using too much memory while your script
is running. All result memory will automatically be freed when
the script ends. You may call <function>mssql_free_result</function>
with the result identifier as an argument and the associated
result memory will be freed.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
The result resource that is being freed. This result comes from a
call to <function>mssql_query</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_result</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Select some data from a table
$query = mssql_query('SELECT * FROM [php].[dbo].[persons]', $link);
// Handle query result here
// When we're done we free the result by calling
// mssql_free_result like so:
mssql_free_result($query);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mssql_free_statement</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:"~/.phpdoc/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
-->