sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 17:08:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Changed some return types.

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@45171 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Damien Seguy 2001-04-12 09:06:49 +00:00
parent 379b687b15
commit de39914434
1 changed files with 12 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
functions/dbx.xml
View file

@ -34,7 +34,7 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbx_close</function></funcdef>
<funcdef>boolean <function>dbx_close</function></funcdef>
<paramdef>dbx_link_object
<parameter>link_identifier</parameter>
</paramdef>
@ -240,7 +240,8 @@ dbx_close ($link);
<para>
Returns a dbx_result_object or 1 on success (a result object is
only returned for sql-statements that return results) or 0 on
failure. The flags parameter is used to control the amount of
failure. The <parameter>flags</parameter> parameter is used to
control the amount of
information that is returned. It may be any combination of the
constants DBX_RESULT_INFO, DBX_RESULT_INDEX, DBX_RESULT_ASSOC,
OR-ed together. DBX_RESULT_INFO provides info about columns, such
@ -249,7 +250,8 @@ dbx_close ($link);
row (or record) number and 3 is the column (or field) number),
where the first row and column are indexed at 0. DBX_RESULT_ASSOC
associates the column indices with field names. Note that
DBX_RESULT_INDEX is always returned, regardless of the flags
DBX_RESULT_INDEX is always returned, regardless of the
<parameter>flags</parameter>
parameter. If DBX_RESULT_ASSOC is specified, DBX_RESULT_INFO is
also returned even if it wasn't specified. This means that
effectively only the combinations DBX_RESULT_INDEX,
@ -264,10 +266,10 @@ dbx_close ($link);
</para>
<para>
A dbx_result_object has five members (possibly four depending on
the flags), 'handle', 'cols', 'rows', 'info' (optional) and
'data'. Handle is a valid result identifier for the specified
module, and as such can be used in module-specific functions, as
seen in the example:
<parameter>flags</parameter>), 'handle', 'cols', 'rows', 'info'
(optional) and 'data'. Handle is a valid result identifier for
the specified module, and as such can be used in module-specific
functions, as seen in the example:
</para>
<para>
<informalexample role="php">
@ -291,8 +293,8 @@ echo "result size: " . $result->rows . " x " . $result->cols . "&lt;br>\n";
</para>
<para>
The info member is only returned if DBX_RESULT_INFO and/or
DBX_RESULT_ASSOC are specified in the flags parameter. It is a 2d
array, that has two named rows ("name" and "type") to retrieve
DBX_RESULT_ASSOC are specified in the <parameter>flags</parameter> parameter.
It is a 2d array, that has two named rows ("name" and "type") to retrieve
column information, e.g.
</para>
<para>
@ -373,7 +375,7 @@ dbx_close($link);
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbx_sort</function></funcdef>
<funcdef>boolean <function>dbx_sort</function></funcdef>
<paramdef>dbx_result_object <parameter>result</parameter></paramdef>
<paramdef>string
<parameter>user_compare_function</parameter>