php-doc-en/reference/mysqli/functions/mysqli-fetch-lengths.xml
Enrique Garcia Briones e23aecf36a changing mysql_* => mysqli_*
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@161085 c90b9560-bf6c-de11-be94-00142212c4b1
2004-06-11 14:09:55 +00:00

151 lines
4.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.12 $ -->
<refentry id="function.mysqli-fetch-lengths">
<refnamediv>
<refname>mysqli_fetch_lengths</refname>
<refname>result->lengths</refname>
<refpurpose>Returns the lengths of the columns of the current row in the result set</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>mixed</type><methodname>mysqli_fetch_lengths</methodname>
<methodparam><type>object</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>result</classname></ooclass>
<fieldsynopsis><type>mixed</type><varname>lengths</varname></fieldsynopsis>
</classsynopsis>
<para>
The <function>mysqli_fetch_lengths</function> function returns an array containing the
lengths of every column of the current row within the result set represented by the
<parameter>result</parameter> parameter. If successful, a numerically indexed array
representing the lengths of each column is returned or &false; on failure.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<para>
An array of integers representing the size of each column (not including
any terminating null characters). &false; if an error occurred.
</para>
<para>
<function>mysqli_fetch_lengths</function> is valid only for the current row of the result set.
It returns &false; if you call it before calling mysqli_fetch_row/array/object or after retrieving
all rows in the result.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<example>
<title>Object oriented style</title>
<programlisting role="php">
<![CDATA[
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");
/* check connection */
if (mysqli_connect_errno()) {
printf("Connect failed: %s\n", mysqli_connect_error());
exit();
}
$query = "SELECT * from Country ORDER BY Code LIMIT 1";
if ($result = $mysqli->query($query)) {
$row = $result->fetch_row();
/* display column lengths */
for ($i=0; $i < count($result->lengths); $i++) {
printf("Field %2d has Length %2d\n", $i+1, $result->lengths[$i]);
}
$result->close();
}
/* close connection */
$mysqli->close();
?>
]]>
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role="php">
<![CDATA[
<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "world");
/* check connection */
if (mysqli_connect_errno()) {
printf("Connect failed: %s\n", mysqli_connect_error());
exit();
}
$query = "SELECT * from Country ORDER BY Code LIMIT 1";
if ($result = mysqli_query($link, $query)) {
$row = mysqli_fetch_row($result);
/* display column lengths */
$lengths = mysqli_fetch_lengths($result);
for ($i=0; $i < count($lengths); $i++) {
printf("Field %2d has Length %2d\n", $i+1, $lengths[$i]);
}
mysqli_free_result($result);
}
/* close connection */
mysqli_close($link);
?>
]]>
</programlisting>
</example>
<para>
The above examples would produce the following output:
</para>
<screen>
<![CDATA[
Field 1 has Length 3
Field 2 has Length 5
Field 3 has Length 13
Field 4 has Length 9
Field 5 has Length 6
Field 6 has Length 1
Field 7 has Length 6
Field 8 has Length 4
Field 9 has Length 6
Field 10 has Length 6
Field 11 has Length 5
Field 12 has Length 44
Field 13 has Length 7
Field 14 has Length 3
Field 15 has Length 2
]]>
</screen>
</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
-->