php-doc-en/reference/mysqli/mysqli/real-query.xml
Jakub Vrana d316f465df Hide properties from method lists
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322005 c90b9560-bf6c-de11-be94-00142212c4b1
2012-01-10 08:41:49 +00:00

94 lines
2.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mysqli.real-query" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::real_query</refname>
<refname>mysqli_real_query</refname>
<refpurpose>Execute an SQL query</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::real_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_real_query</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
Executes a single query against the database whose result can then be
retrieved or stored using the <function>mysqli_store_result</function> or
<function>mysqli_use_result</function> functions.
</para>
<para>
In order to determine if a given query should return a result set or not,
see <function>mysqli_field_count</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&mysqli.link.description;
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
The query, as a string.
</para>
<para>
Data inside the query should be <link
linkend="mysqli.real-escape-string">properly escaped</link>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mysqli_query</function></member>
<member><function>mysqli_store_result</function></member>
<member><function>mysqli_use_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:"~/.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
-->