php-doc-en/reference/mssql/functions/mssql-close.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

119 lines
2.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mssql-close" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mssql_close</refname>
<refpurpose>Close MS SQL Server connection</refpurpose>
</refnamediv>
<refsynopsisdiv>
<warning>
&warn.removed.function.7-0-0.alternatives;
<simplelist role="alternatives">
<member><function>sqlsrv_close</function></member>
<member><function>odbc_close</function></member>
<member><function>odbc_close_all</function></member>
</simplelist>
</warning>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mssql_close</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Closes the link to a MS SQL Server database that's associated with the
specified link identifier. If the link identifier isn't specified, the
last opened link is assumed.
</para>
<para>
Note that this isn't usually necessary, as non-persistent open
links are automatically closed at the end of the script's
execution.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
A MS SQL link identifier, returned by
<function>mssql_connect</function>.
</para>
<para>
This function will not close persistent links generated by
<function>mssql_pconnect</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_close</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Connect to MSSQL
$link = mssql_connect('KALLESPC\SQLEXPRESS', 'sa', 'phpfi');
// Do any related operations here
// Close the link to MSSQL
mssql_close($link);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mssql_connect</function></member>
<member><function>mssql_pconnect</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
-->