mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
66834c02bb
added samples git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@151924 c90b9560-bf6c-de11-be94-00142212c4b1
92 lines
3.3 KiB
XML
92 lines
3.3 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.2 $ -->
|
|
<refentry id="function.mysqli-get-metadata">
|
|
<refnamediv>
|
|
<refname>mysqli_get_metadata</refname>
|
|
<refpurpose></refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>Procedural style:</para>
|
|
<methodsynopsis>
|
|
<type>mixed</type><methodname>mysqli_get_metadata</methodname>
|
|
<methodparam><type>object</type><parameter>stmt</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>Object oriented style (method):</para>
|
|
<classsynopsis>
|
|
<ooclass><classname>stmt</classname></ooclass>
|
|
<methodsynopsis>
|
|
<type>mixed</type>
|
|
<methodname>get_metadata</methodname>
|
|
<methodparam><type>void</type><parameter></parameter></methodparam>
|
|
</methodsynopsis>
|
|
</classsynopsis>
|
|
<para>
|
|
If a statement passed to <function>mysqli_prepare</function> is one that produces
|
|
a result set, <function>mysqli_get_metadata</function> returns the result object
|
|
that can be used to process the meta information such as total number of fields
|
|
and individual field information.
|
|
</para>
|
|
<note>
|
|
<para>This result set pointer can be passed as an argument to any of the
|
|
field-based functions that process result set metadata, such as:
|
|
<itemizedlist>
|
|
<listitem><para><function>mysqli_num_fields</function></para></listitem>
|
|
<listitem><para><function>mysqli_fetch_field</function></para></listitem>
|
|
<listitem><para><function>mysqli_fetch_field_direct</function></para></listitem>
|
|
<listitem><para><function>mysqli_fetch_fields</function></para></listitem>
|
|
<listitem><para><function>mysqli_field_count</function></para></listitem>
|
|
<listitem><para><function>mysqli_field_seek</function></para></listitem>
|
|
<listitem><para><function>mysqli_field_tell</function></para></listitem>
|
|
<listitem><para><function>mysqli_free_result</function></para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</note>
|
|
<para>
|
|
The result set structure should be freed when you are done with it,
|
|
which you can do by passing it to <function>mysqli_free_result</function>
|
|
</para>
|
|
<note>
|
|
<para>
|
|
The result set returned by <function>mysqli_get_metadata</function> contains only
|
|
metadata. It does not contain any row results. The rows are obtained by using the
|
|
statement handle with <function>mysqli_fetch</function>.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
<refsect1>
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
<function>mysqli_get_metadata</function> returns a result object or &false; if
|
|
an error occured.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>See also:</title>
|
|
<para>
|
|
<function>mysqli_prepare</function>,
|
|
<function>mysqli_free_result</function>
|
|
</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
|
|
-->
|