php-doc-en/reference/mssql/functions/mssql-query.xml
Daniel Egeberg 0640e024d4 Fixed PHP bug #51978
for file in `ack -i '\bA\s+SQL' -l`; do perl -i -pe 's/\b(a)(\s+SQL)/\1n\2/gi' $file; done


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@300101 c90b9560-bf6c-de11-be94-00142212c4b1
2010-06-02 18:45:11 +00:00

144 lines
3.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mssql-query" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mssql_query</refname>
<refpurpose>Send MS SQL query</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>mssql_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>batch_size</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<function>mssql_query</function> sends a query to the currently active
database on the server that's associated with the specified link
identifier.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
An SQL query.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
A MS SQL link identifier, returned by
<function>mssql_connect</function> or
<function>mssql_pconnect</function>.
</para>
<para>
If the link identifier isn't specified, the last opened link is
assumed. If no link is open, the function tries to establish a link
as if <function>mssql_connect</function> was called, and use it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>batch_size</parameter></term>
<listitem>
<para>
The number of records to batch in the buffer.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a MS SQL result resource on success, &true; if no rows were
returned, or &false; on error.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>mssql_query</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Connect to MSSQL
$link = mssql_connect('KALLESPC\SQLEXPRESS', 'sa', 'phpfi');
if (!$link || !mssql_select_db('php', $link)) {
die('Unable to connect or select database!');
}
// Do a simple query, select the version of
// MSSQL and print it.
$version = mssql_query('SELECT @@VERSION');
$row = mssql_fetch_array($version);
echo $row[0];
// Clean up
mssql_free_result($version);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
If the query returns multiple results then it is necessary to fetch all
results by <function>mssql_next_result</function> or free the results by
<function>mssql_free_result</function> before executing next query.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mssql_select_db</function></member>
<member><function>mssql_connect</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
-->