cvs: phpdoc /en/functions fbsql.xml
| From: | Damien Seguy | Date: | Wed, 09 May 2001 07:48:07 +0000 |
| Subject: | cvs: phpdoc /en/functions fbsql.xml | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969335211@lists.php.net to get a copy of this message | ||
dams Wed May 9 00:48:07 2001 EDT
Modified files:
/phpdoc/en/functions fbsql.xml
Log:
Corrected some prototype description.One minor typo.
Index: phpdoc/en/functions/fbsql.xml diff -u phpdoc/en/functions/fbsql.xml:1.1 phpdoc/en/functions/fbsql.xml:1.2 --- phpdoc/en/functions/fbsql.xml:1.1 Tue May 1 11:12:13 2001 +++ phpdoc/en/functions/fbsql.xml Wed May 9 00:48:07 2001 @@ -8,7 +8,7 @@ with fbsql support by using the <option role="configure">--with-fbsql</option> option. If you use this option without specifying the path to fbsql, php will - search for the fbsql client libraries in the default instalation + search for the fbsql client libraries in the default installation location for the platform. Users who installed FrontBase in a non standard directory should always specify the path to fbsql: <option role="configure">--with-fbsql=/path/to/fbsql</option>. @@ -153,7 +153,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>fbsql_close</function></funcdef> + <funcdef>boolean <function>fbsql_close</function></funcdef> <paramdef>int <parameter> <optional>link_identifier</optional> @@ -162,7 +162,7 @@ </funcprototype> </funcsynopsis> <para> - Returns: true on success, false on error. + Returns: <literal>TRUE</literal> on success, <literal>FALSE</literal> on error. </para> <para> <function>fbsql_close</function> closes the connection to the FrontBase server that's associated with the specified link @@ -203,7 +203,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>fbsql_connect</function></funcdef> + <funcdef>resource <function>fbsql_connect</function></funcdef> <paramdef>string <parameter> <optional>hostname @@ -316,13 +316,13 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>fbsql_data_seek</function></funcdef> + <funcdef>boolean <function>fbsql_data_seek</function></funcdef> <paramdef>int <parameter>result_identifier</parameter></paramdef> <paramdef>int <parameter>row_number</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - Returns: true on success, false on failure. + Returns: <literal>TRUE</literal> on success, <literal>FALSE</literal> on failure. </para> <para> <function>fbsql_data_seek</function> moves the internal row @@ -378,7 +378,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>fbsql_db_query</function></funcdef> + <funcdef>resource <function>fbsql_db_query</function></funcdef> <paramdef>string <parameter>database</parameter></paramdef> <paramdef>string <parameter>query</parameter></paramdef> <paramdef>int @@ -390,7 +390,7 @@ </funcsynopsis> <para> Returns: A positive FrontBase result identifier to the query result, - or false on error. + or <literal>FALSE</literal> on error. </para> <para> <function>fbsql_db_query</function> selects a database and @@ -415,7 +415,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>fbsql_drop_db</function></funcdef> + <funcdef>boolean <function>fbsql_drop_db</function></funcdef> <paramdef>string <parameter>database_name</parameter></paramdef> <paramdef>int <parameter> @@ -425,7 +425,7 @@ </funcprototype> </funcsynopsis> <para> - Returns: true on success, false on failure. + Returns: <literal>TRUE</literal> on success, <literal>FALSE</literal> on failure. </para> <para> <function>fbsql_drop_db</function> attempts to drop (remove) an @@ -557,7 +557,7 @@ </funcprototype> </funcsynopsis> <para> - Returns an array that corresponds to the fetched row, or false + Returns an array that corresponds to the fetched row, or <literal>FALSE</literal> if there are no more rows.</para> <para> <function>fbsql_fetch_array</function> is an extended version of @@ -628,7 +628,7 @@ </funcsynopsis> <para> Returns an associative array that corresponds to the fetched row, - or false if there are no more rows.</para> + or <literal>FALSE</literal> if there are no more rows.</para> <para> <function>fbsql_fetch_assoc</function> is equivalent to calling <function>fbsql_fetch_array</function> with FBSQL_ASSOC for the @@ -785,7 +785,7 @@ <para> Returns: An array that corresponds to the lengths of each field in the last row fetched by <function>fbsql_fetch_row</function>, - or false on error. + or <literal>FALSE</literal> on error. </para> <para> <function>fbsql_fetch_lengths</function> stores the lengths of @@ -821,7 +821,7 @@ </funcsynopsis> <para> Returns an object with properties that correspond to the fetched - row, or false if there are no more rows. + row, or <literal>FALSE</literal> if there are no more rows. </para> <para> <function>fbsql_fetch_object</function> is similar to @@ -876,7 +876,7 @@ </funcprototype> </funcsynopsis> <para> - Returns: An array that corresponds to the fetched row, or false + Returns: An array that corresponds to the fetched row, or <literal>FALSE</literal> if there are no more rows. </para> <para> @@ -887,7 +887,7 @@ </para> <para> Subsequent call to <function>fbsql_fetch_row</function> would - return the next row in the result set, or false if there are no + return the next row in the result set, or <literal>FALSE</literal> if there are no more rows. </para> <para> @@ -1444,7 +1444,7 @@ </funcsynopsis> <para> Returns: A positive FrontBase persistent link identifier on success, - or false on error. + or <literal>FALSE</literal> on error. </para> <para> <function>fbsql_pconnect</function> establishes a connection @@ -1511,16 +1511,16 @@ </para> </note> <para> - <function>fbsql_query</function> returns TRUE (non-zero) or FALSE + <function>fbsql_query</function> returns <literal>TRUE</literal> (non-zero) or <literal>FALSE</literal> to indicate whether or not the query succeeded. A return value - of TRUE means that the query was legal and could be executed by + of <literal>TRUE</literal> means that the query was legal and could be executed by the server. It does not indicate anything about the number of rows affected or returned. It is perfectly possible for a query to succeed but affect no rows or return no rows. </para> <para> The following query is syntactically invalid, so - <function>fbsql_query</function> fails and returns FALSE: + <function>fbsql_query</function> fails and returns <literal>FALSE</literal>: <example> <title><function>fbsql_query</function></title> <programlisting role="php"> @@ -1535,7 +1535,7 @@ The following query is semantically invalid if <literal>my_col</literal> is not a column in the table <literal>my_tbl</literal>, so <function>fbsql_query</function> - fails and returns FALSE: + fails and returns <literal>FALSE</literal>: <example> <title><function>fbsql_query</function></title> <programlisting role="php"> @@ -1547,7 +1547,7 @@ </example> </para> <para> - <function>fbsql_query</function> will also fail and return FALSE + <function>fbsql_query</function> will also fail and return <literal>FALSE</literal> if you don't have permission to access the table(s) referenced by the query. </para> @@ -1647,7 +1647,7 @@ </funcprototype> </funcsynopsis> <para> - Returns: true on success, false on error. + Returns: <literal>TRUE</literal> on success, <literal>FALSE</literal> on error. </para> <para> <function>fbsql_select_db</function> sets the current active @@ -1726,7 +1726,7 @@ </funcprototype> </funcsynopsis> <para> - Returns: true if warnings is turned on otherwise false. + Returns: <literal>TRUE</literal> if warnings is turned on otherwise <literal>FALSE</literal>. </para> <para> <function>fbsql_warnings</function> enables or disables FrontBase
Index: phpdoc/en/functions/fbsql.xml diff -u phpdoc/en/functions/fbsql.xml:1.1 phpdoc/en/functions/fbsql.xml:1.2 --- phpdoc/en/functions/fbsql.xml:1.1 Tue May 1 11:12:13 2001 +++ phpdoc/en/functions/fbsql.xml Wed May 9 00:48:07 2001 @@ -8,7 +8,7 @@ with fbsql support by using the <option role="configure">--with-fbsql</option> option. If you use this option without specifying the path to fbsql, php will - search for the fbsql client libraries in the default instalation + search for the fbsql client libraries in the default installation location for the platform. Users who installed FrontBase in a non standard directory should always specify the path to fbsql: <option role="configure">--with-fbsql=/path/to/fbsql</option>. @@ -153,7 +153,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>fbsql_close</function></funcdef> + <funcdef>boolean <function>fbsql_close</function></funcdef> <paramdef>int <parameter> <optional>link_identifier</optional> @@ -162,7 +162,7 @@ </funcprototype> </funcsynopsis> <para> - Returns: true on success, false on error. + Returns: <literal>TRUE</literal> on success, <literal>FALSE</literal> on error. </para> <para> <function>fbsql_close</function> closes the connection to the FrontBase server that's associated with the specified link @@ -203,7 +203,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>fbsql_connect</function></funcdef> + <funcdef>resource <function>fbsql_connect</function></funcdef> <paramdef>string <parameter> <optional>hostname @@ -316,13 +316,13 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>fbsql_data_seek</function></funcdef> + <funcdef>boolean <function>fbsql_data_seek</function></funcdef> <paramdef>int <parameter>result_identifier</parameter></paramdef> <paramdef>int <parameter>row_number</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - Returns: true on success, false on failure. + Returns: <literal>TRUE</literal> on success, <literal>FALSE</literal> on failure. </para> <para> <function>fbsql_data_seek</function> moves the internal row @@ -378,7 +378,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>fbsql_db_query</function></funcdef> + <funcdef>resource <function>fbsql_db_query</function></funcdef> <paramdef>string <parameter>database</parameter></paramdef> <paramdef>string <parameter>query</parameter></paramdef> <paramdef>int @@ -390,7 +390,7 @@ </funcsynopsis> <para> Returns: A positive FrontBase result identifier to the query result, - or false on error. + or <literal>FALSE</literal> on error. </para> <para> <function>fbsql_db_query</function> selects a database and @@ -415,7 +415,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>fbsql_drop_db</function></funcdef> + <funcdef>boolean <function>fbsql_drop_db</function></funcdef> <paramdef>string <parameter>database_name</parameter></paramdef> <paramdef>int <parameter> @@ -425,7 +425,7 @@ </funcprototype> </funcsynopsis> <para> - Returns: true on success, false on failure. + Returns: <literal>TRUE</literal> on success, <literal>FALSE</literal> on failure. </para> <para> <function>fbsql_drop_db</function> attempts to drop (remove) an @@ -557,7 +557,7 @@ </funcprototype> </funcsynopsis> <para> - Returns an array that corresponds to the fetched row, or false + Returns an array that corresponds to the fetched row, or <literal>FALSE</literal> if there are no more rows.</para> <para> <function>fbsql_fetch_array</function> is an extended version of @@ -628,7 +628,7 @@ </funcsynopsis> <para> Returns an associative array that corresponds to the fetched row, - or false if there are no more rows.</para> + or <literal>FALSE</literal> if there are no more rows.</para> <para> <function>fbsql_fetch_assoc</function> is equivalent to calling <function>fbsql_fetch_array</function> with FBSQL_ASSOC for the @@ -785,7 +785,7 @@ <para> Returns: An array that corresponds to the lengths of each field in the last row fetched by <function>fbsql_fetch_row</function>, - or false on error. + or <literal>FALSE</literal> on error. </para> <para> <function>fbsql_fetch_lengths</function> stores the lengths of @@ -821,7 +821,7 @@ </funcsynopsis> <para> Returns an object with properties that correspond to the fetched - row, or false if there are no more rows. + row, or <literal>FALSE</literal> if there are no more rows. </para> <para> <function>fbsql_fetch_object</function> is similar to @@ -876,7 +876,7 @@ </funcprototype> </funcsynopsis> <para> - Returns: An array that corresponds to the fetched row, or false + Returns: An array that corresponds to the fetched row, or <literal>FALSE</literal> if there are no more rows. </para> <para> @@ -887,7 +887,7 @@ </para> <para> Subsequent call to <function>fbsql_fetch_row</function> would - return the next row in the result set, or false if there are no + return the next row in the result set, or <literal>FALSE</literal> if there are no more rows. </para> <para> @@ -1444,7 +1444,7 @@ </funcsynopsis> <para> Returns: A positive FrontBase persistent link identifier on success, - or false on error. + or <literal>FALSE</literal> on error. </para> <para> <function>fbsql_pconnect</function> establishes a connection @@ -1511,16 +1511,16 @@ </para> </note> <para> - <function>fbsql_query</function> returns TRUE (non-zero) or FALSE + <function>fbsql_query</function> returns <literal>TRUE</literal> (non-zero) or <literal>FALSE</literal> to indicate whether or not the query succeeded. A return value - of TRUE means that the query was legal and could be executed by + of <literal>TRUE</literal> means that the query was legal and could be executed by the server. It does not indicate anything about the number of rows affected or returned. It is perfectly possible for a query to succeed but affect no rows or return no rows. </para> <para> The following query is syntactically invalid, so - <function>fbsql_query</function> fails and returns FALSE: + <function>fbsql_query</function> fails and returns <literal>FALSE</literal>: <example> <title><function>fbsql_query</function></title> <programlisting role="php"> @@ -1535,7 +1535,7 @@ The following query is semantically invalid if <literal>my_col</literal> is not a column in the table <literal>my_tbl</literal>, so <function>fbsql_query</function> - fails and returns FALSE: + fails and returns <literal>FALSE</literal>: <example> <title><function>fbsql_query</function></title> <programlisting role="php"> @@ -1547,7 +1547,7 @@ </example> </para> <para> - <function>fbsql_query</function> will also fail and return FALSE + <function>fbsql_query</function> will also fail and return <literal>FALSE</literal> if you don't have permission to access the table(s) referenced by the query. </para> @@ -1647,7 +1647,7 @@ </funcprototype> </funcsynopsis> <para> - Returns: true on success, false on error. + Returns: <literal>TRUE</literal> on success, <literal>FALSE</literal> on error. </para> <para> <function>fbsql_select_db</function> sets the current active @@ -1726,7 +1726,7 @@ </funcprototype> </funcsynopsis> <para> - Returns: true if warnings is turned on otherwise false. + Returns: <literal>TRUE</literal> if warnings is turned on otherwise <literal>FALSE</literal>. </para> <para> <function>fbsql_warnings</function> enables or disables FrontBase