cvs: phpdoc /en/reference/sybase/functions sybase-affected-rows.xml sybase-close.xml sybase-connect.xml sybase-data-seek.xml
sybase-deadlock-retry-count.xml sybase-fetch-array.xml sybase-fetch-assoc.xml sybase-fetch-field.xml sybase-fetch-object.xml sybase-fetch-row.xml
sybase-field-seek.xml sybase-free-result.xml sybase-get-last-message.xml sybase-min-client-severity.xml sybase-min-error-severity.xml
sybase-min-message-severity.xml sybase-min-server-severity.xml sybase-num-fields.xml sybase-num-rows.xml sybase-pconnect.xml sybase-query.xml
sybase-result.xml sybase-select-db.xml sybase-set-message-handler.xml sybase-unbuffered-query.xml

didou Sat Jul 12 12:25:58 2003 EDT Modified files: /phpdoc/en/reference/sybase/functions sybase-affected-rows.xml sybase-close.xml sybase-connect.xml sybase-data-seek.xml sybase-deadlock-retry-count.xml sybase-fetch-array.xml sybase-fetch-assoc.xml sybase-fetch-field.xml sybase-fetch-object.xml sybase-fetch-row.xml sybase-field-seek.xml sybase-free-result.xml sybase-get-last-message.xml sybase-min-client-severity.xml sybase-min-error-severity.xml sybase-min-message-severity.xml sybase-min-server-severity.xml sybase-num-fields.xml sybase-num-rows.xml sybase-pconnect.xml sybase-query.xml sybase-result.xml sybase-select-db.xml sybase-set-message-handler.xml sybase-unbuffered-query.xml Log: protos, see also, examples, XML structure

Index: phpdoc/en/reference/sybase/functions/sybase-affected-rows.xml diff -u phpdoc/en/reference/sybase/functions/sybase-affected-rows.xml:1.3 phpdoc/en/reference/sybase/functions/sybase-affected-rows.xml:1.4 --- phpdoc/en/reference/sybase/functions/sybase-affected-rows.xml:1.3 Wed Jan 29 16:18:27 2003 +++ phpdoc/en/reference/sybase/functions/sybase-affected-rows.xml Sat Jul 12 12:25:58 2003 @@ -1,27 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 --> <refentry id="function.sybase-affected-rows"> <refnamediv> <refname>sybase_affected_rows</refname> - <refpurpose>get number of affected rows in last query</refpurpose> + <refpurpose>Gets number of affected rows in last query</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>int</type><methodname>sybase_affected_rows</methodname> - <methodparam choice="opt"><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> - Returns: The number of affected rows by the last query. - </para> - <para> <function>sybase_affected_rows</function> returns the number of rows affected by the last INSERT, UPDATE or DELETE query on the server associated with the specified link identifier. If the link identifier isn't specified, the last opened link is assumed. </para> <para> + <example> + <title>Delete-Query</title> + <programlisting role="php"> +<![CDATA[ +<?php + /* connect to database */ + sybase_connect('SYBASE', '', '') or + die("Could not connect"); + sybase_select_db("db"); + + sybase_query("DELETE FROM sometable WHERE id < 10"); + printf ("Records deleted: %d\n", sybase_affected_rows()); +?> +]]> + </programlisting> + <para> + The above example would produce the following output: + </para> + <screen> +<![CDATA[ + Records deleted: 10 +]]> + </screen> + </example> + </para> + <para> This command is not effective for SELECT statements, only on statements which modify records. To retrieve the number of rows returned from a SELECT, use <function>sybase_num_rows</function>. @@ -31,6 +54,9 @@ to Sybase, and not the DB library. </para> </note> + </para> + <para> + See also <function>sybase_num_rows</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/sybase/functions/sybase-close.xml diff -u phpdoc/en/reference/sybase/functions/sybase-close.xml:1.3 phpdoc/en/reference/sybase/functions/sybase-close.xml:1.4 --- phpdoc/en/reference/sybase/functions/sybase-close.xml:1.3 Wed Jan 29 16:18:34 2003 +++ phpdoc/en/reference/sybase/functions/sybase-close.xml Sat Jul 12 12:25:58 2003 @@ -1,16 +1,16 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 --> <refentry id="function.sybase-close"> <refnamediv> <refname>sybase_close</refname> - <refpurpose>close Sybase connection</refpurpose> + <refpurpose>Closes a Sybase connection</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>bool</type><methodname>sybase_close</methodname> - <methodparam choice="opt"><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> <function>sybase_close</function> closes the link to a Sybase @@ -22,16 +22,19 @@ <para> &return.success; </para> - <para> Note that this isn't usually necessary, as non-persistent - open links are automatically closed at the end of the script's - execution. + <para> + Note that this isn't usually necessary, as non-persistent + open links are automatically closed at the end of the script's + execution. </para> <para> <function>sybase_close</function> will not close persistent links generated by <function>sybase_pconnect</function>. </para> - <para> See also: <function>sybase_connect</function>, - <function>sybase_pconnect</function>. + <para> + See also + <function>sybase_connect</function> and + <function>sybase_pconnect</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/sybase/functions/sybase-connect.xml diff -u phpdoc/en/reference/sybase/functions/sybase-connect.xml:1.2 phpdoc/en/reference/sybase/functions/sybase-connect.xml:1.3 --- phpdoc/en/reference/sybase/functions/sybase-connect.xml:1.2 Wed Apr 17 02:44:39 2002 +++ phpdoc/en/reference/sybase/functions/sybase-connect.xml Sat Jul 12 12:25:58 2003 @@ -1,22 +1,24 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 --> <refentry id="function.sybase-connect"> <refnamediv> <refname>sybase_connect</refname> - <refpurpose>open Sybase server connection</refpurpose> + <refpurpose>Opens a Sybase server connection</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>sybase_connect</methodname> - <methodparam><type>string</type><parameter>servername</parameter></methodparam> - <methodparam><type>string</type><parameter>username</parameter></methodparam> - <methodparam><type>string</type><parameter>password</parameter></methodparam> + <type>resource</type><methodname>sybase_connect</methodname> + <methodparam choice="opt"><type>string</type><parameter>servername</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>appname</parameter></methodparam> </methodsynopsis> - <para> Returns: A positive Sybase link identifier on success, or - &false; on error. + <para> + Returns a positive Sybase link identifier on success, or + &false; on failure. </para> <para> <function>sybase_connect</function> establishes a connection to a @@ -29,12 +31,28 @@ new link will be established, but instead, the link identifier of the already opened link will be returned. </para> - <para> The link to the server will be closed as soon as the - execution of the script ends, unless it's closed earlier by - explicitly calling <function>sybase_close</function>. + <para> + The link to the server will be closed as soon as the + execution of the script ends, unless it's closed earlier by + explicitly calling <function>sybase_close</function>. + </para> + <para> + <example> + <title><function>sybase_connect</function> example</title> + <programlisting role="php"> +<?php + $link = sybase_connect('SYBASE', '', '') + or die("Could not connect !"); + print ("Connected successfully"); + sybase_close($link); +?> + </programlisting> + </example> </para> - <para>See also <function>sybase_pconnect</function>, - <function>sybase_close</function>. + <para> + See also + <function>sybase_pconnect</function> and + <function>sybase_close</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/sybase/functions/sybase-data-seek.xml diff -u phpdoc/en/reference/sybase/functions/sybase-data-seek.xml:1.2 phpdoc/en/reference/sybase/functions/sybase-data-seek.xml:1.3 --- phpdoc/en/reference/sybase/functions/sybase-data-seek.xml:1.2 Wed Apr 17 02:44:39 2002 +++ phpdoc/en/reference/sybase/functions/sybase-data-seek.xml Sat Jul 12 12:25:58 2003 @@ -1,19 +1,20 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 --> <refentry id="function.sybase-data-seek"> <refnamediv> <refname>sybase_data_seek</refname> - <refpurpose>move internal row pointer</refpurpose> + <refpurpose>Moves internal row pointer</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>bool</type><methodname>sybase_data_seek</methodname> - <methodparam><type>int</type><parameter>result_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam> <methodparam><type>int</type><parameter>row_number</parameter></methodparam> </methodsynopsis> - <para> Returns: &true; on success, &false; on failure + <para> + &return.success; </para> <para> <function>sybase_data_seek</function> moves the internal row @@ -21,7 +22,9 @@ identifier to pointer to the specifyed row number. The next call to <function>sybase_fetch_row</function> would return that row. </para> - <para> See also: <function>sybase_data_seek</function>. + <para> + See also + <function>sybase_fetch_row</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/sybase/functions/sybase-deadlock-retry-count.xml diff -u phpdoc/en/reference/sybase/functions/sybase-deadlock-retry-count.xml:1.1 phpdoc/en/reference/sybase/functions/sybase-deadlock-retry-count.xml:1.2 --- phpdoc/en/reference/sybase/functions/sybase-deadlock-retry-count.xml:1.1 Fri Feb 7 19:57:14 2003 +++ phpdoc/en/reference/sybase/functions/sybase-deadlock-retry-count.xml Sat Jul 12 12:25:58 2003 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.sybase-deadlock-retry-count"> <refnamediv> <refname>sybase_deadlock_retry_count</refname> - <refpurpose>set the deadlock retry count</refpurpose> + <refpurpose>Sets the deadlock retry count</refpurpose> </refnamediv> <refsect1> <title>Description</title> Index: phpdoc/en/reference/sybase/functions/sybase-fetch-array.xml diff -u phpdoc/en/reference/sybase/functions/sybase-fetch-array.xml:1.3 phpdoc/en/reference/sybase/functions/sybase-fetch-array.xml:1.4 --- phpdoc/en/reference/sybase/functions/sybase-fetch-array.xml:1.3 Sun Mar 23 12:23:25 2003 +++ phpdoc/en/reference/sybase/functions/sybase-fetch-array.xml Sat Jul 12 12:25:58 2003 @@ -1,19 +1,20 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 --> <refentry id="function.sybase-fetch-array"> <refnamediv> <refname>sybase_fetch_array</refname> - <refpurpose>fetch row as array</refpurpose> + <refpurpose>Fetch row as array</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>array</type><methodname>sybase_fetch_array</methodname> - <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> - <para> Returns: An array that corresponds to the fetched row, or - &false; if there are no more rows. + <para> + Returns an array that corresponds to the fetched row, or + &false; if there are no more rows. </para> <para> <function>sybase_fetch_array</function> is an extended version of @@ -28,31 +29,30 @@ provides a significant added value. </para> <note> - <para> When selecting fields with identical names (for instance, in - a join), the associative indices will have a sequential number prepended. - See the example for details. + <para> + When selecting fields with identical names (for instance, in + a join), the associative indices will have a sequential number prepended. + See the example for details. </para> </note> - <example> - <title>Identical fieldnames</title> - <programlisting role="php"> + <para> + <example> + <title>Identical fieldnames</title> + <programlisting role="php"> <![CDATA[ <?php - $dbh= sybase_connect('SYBASE', '', ''); - $q= sybase_query( - 'SELECT * FROM p, a WHERE p.person_id= a.person_id', - $dbh - ); + $dbh = sybase_connect('SYBASE', '', ''); + $q = sybase_query('SELECT * FROM p, a WHERE p.person_id= a.person_id'); var_dump(sybase_fetch_array($q)); sybase_close($dbh); ?> ]]> - </programlisting> - <para> - The above example would produce the following output (assuming the two tables only - have each one column called "person_id"): - </para> - <screen> + </programlisting> + <para> + The above example would produce the following output (assuming the two tables only + have each one column called "person_id"): + </para> + <screen> <![CDATA[ array(4) { [0]=> @@ -65,10 +65,11 @@ int(1) } ]]> - </screen> - </example> + </screen> + </example> + </para> <para> - For further details, also see + See also <function>sybase_fetch_row</function>, <function>sybase_fetch_assoc</function> and <function>sybase_fetch_object</function>. Index: phpdoc/en/reference/sybase/functions/sybase-fetch-assoc.xml diff -u phpdoc/en/reference/sybase/functions/sybase-fetch-assoc.xml:1.2 phpdoc/en/reference/sybase/functions/sybase-fetch-assoc.xml:1.3 --- phpdoc/en/reference/sybase/functions/sybase-fetch-assoc.xml:1.2 Wed Feb 19 17:10:28 2003 +++ phpdoc/en/reference/sybase/functions/sybase-fetch-assoc.xml Sat Jul 12 12:25:58 2003 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.sybase-fetch-assoc"> <refnamediv> <refname>sybase_fetch_assoc</refname> - <refpurpose>fetch row as associative array</refpurpose> + <refpurpose>Fetch a result row as an associative array</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -11,8 +11,9 @@ <type>array</type><methodname>sybase_fetch_assoc</methodname> <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> - <para> Returns: An array that corresponds to the fetched row, or - &false; if there are no more rows. + <para> + Returns an array that corresponds to the fetched row, or + &false; if there are no more rows. </para> <para> <function>sybase_fetch_assoc</function> is a version of @@ -30,7 +31,7 @@ <para> See also <function>sybase_fetch_array</function>, - <function>sybase_fetch_object</function>, and + <function>sybase_fetch_object</function> and <function>sybase_fetch_row</function>. </para> </refsect1> Index: phpdoc/en/reference/sybase/functions/sybase-fetch-field.xml diff -u phpdoc/en/reference/sybase/functions/sybase-fetch-field.xml:1.2 phpdoc/en/reference/sybase/functions/sybase-fetch-field.xml:1.3 --- phpdoc/en/reference/sybase/functions/sybase-fetch-field.xml:1.2 Wed Apr 17 02:44:40 2002 +++ phpdoc/en/reference/sybase/functions/sybase-fetch-field.xml Sat Jul 12 12:25:58 2003 @@ -1,16 +1,16 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 --> <refentry id="function.sybase-fetch-field"> <refnamediv> <refname>sybase_fetch_field</refname> - <refpurpose>get field information</refpurpose> + <refpurpose>Get field information from a result</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>object</type><methodname>sybase_fetch_field</methodname> - <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>field_offset</parameter></methodparam> </methodsynopsis> <para> @@ -25,28 +25,36 @@ <para> The properties of the object are: </para> - - <itemizedlist> - <listitem><simpara> - name - column name. if the column is a result of a function, this property is set to computed#N, - where #N is a serial number. - </simpara></listitem> - <listitem><simpara> - column_source - the table from which the column was taken - </simpara></listitem> - <listitem><simpara> - max_length - maximum length of the column - </simpara></listitem> - <listitem><simpara> - numeric - 1 if the column is numeric - </simpara></listitem> - <listitem><simpara> + <itemizedlist> + <listitem> + <simpara> + name - column name. if the column is a result of a function, this + property is set to computed#N, where #N is a serial number. + </simpara> + </listitem> + <listitem> + <simpara> + column_source - the table from which the column was taken + </simpara> + </listitem> + <listitem> + <simpara> + max_length - maximum length of the column + </simpara> + </listitem> + <listitem> + <simpara> + numeric - 1 if the column is numeric + </simpara> + </listitem> + <listitem> + <simpara> type - datatype of the column - </simpara></listitem> - </itemizedlist> - + </simpara> + </listitem> + </itemizedlist> <para> - See also <function>sybase_field_seek</function> + See also <function>sybase_field_seek</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/sybase/functions/sybase-fetch-object.xml diff -u phpdoc/en/reference/sybase/functions/sybase-fetch-object.xml:1.4 phpdoc/en/reference/sybase/functions/sybase-fetch-object.xml:1.5 --- phpdoc/en/reference/sybase/functions/sybase-fetch-object.xml:1.4 Sun Mar 23 12:23:25 2003 +++ phpdoc/en/reference/sybase/functions/sybase-fetch-object.xml Sat Jul 12 12:25:58 2003 @@ -1,20 +1,20 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 --> <refentry id="function.sybase-fetch-object"> <refnamediv> <refname>sybase_fetch_object</refname> - <refpurpose>fetch row as object</refpurpose> + <refpurpose>Fetch a row as an object</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>sybase_fetch_object</methodname> - <methodparam><type>int</type><parameter>result</parameter></methodparam> + <type>object</type><methodname>sybase_fetch_object</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam choice="opt"><type>mixed</type><parameter>object</parameter></methodparam> </methodsynopsis> <para> - Returns: An object with properties that correspond to the + Returns an object with properties that correspond to the fetched row, or &false; if there are no more rows. </para> <para> @@ -60,9 +60,10 @@ </screen> </para> </note> - <example> - <title><function>sybase_fetch_object</function> return as Foo</title> - <programlisting role="php"> + <para> + <example> + <title><function>sybase_fetch_object</function> return as Foo</title> + <programlisting role="php"> <![CDATA[ <?php class Foo { @@ -76,15 +77,17 @@ // {...] ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> <para> Speed-wise, the function is identical to <function>sybase_fetch_array</function>, and almost as quick as <function>sybase_fetch_row</function> (the difference is insignificant). </para> <para> - See also <function>sybase_fetch_array</function>, and + See also + <function>sybase_fetch_array</function> and <function>sybase_fetch_row</function>. </para> </refsect1> Index: phpdoc/en/reference/sybase/functions/sybase-fetch-row.xml diff -u phpdoc/en/reference/sybase/functions/sybase-fetch-row.xml:1.4 phpdoc/en/reference/sybase/functions/sybase-fetch-row.xml:1.5 --- phpdoc/en/reference/sybase/functions/sybase-fetch-row.xml:1.4 Sun Mar 23 12:23:25 2003 +++ phpdoc/en/reference/sybase/functions/sybase-fetch-row.xml Sat Jul 12 12:25:58 2003 @@ -1,19 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 --> <refentry id="function.sybase-fetch-row"> <refnamediv> <refname>sybase_fetch_row</refname> - <refpurpose>get row as enumerated array</refpurpose> + <refpurpose>Get a result row as an enumerated array</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>array</type><methodname>sybase_fetch_row</methodname> - <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> <para> - Returns: An array that corresponds to the fetched row, or + Returns an array that corresponds to the fetched row, or &false; if there are no more rows. </para> <para> @@ -57,12 +57,12 @@ </tgroup> </table> <para> - See also: <function>sybase_fetch_array</function>, - <function>sybase_fetch_assoc</function>, - <function>sybase_fetch_object</function>, - <function>sybase_data_seek</function>, - <function>sybase_fetch_lengths</function>, and - <function>sybase_result</function>. + See also + <function>sybase_fetch_array</function>, + <function>sybase_fetch_assoc</function>, + <function>sybase_fetch_object</function>, + <function>sybase_data_seek</function> and + <function>sybase_result</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/sybase/functions/sybase-field-seek.xml diff -u phpdoc/en/reference/sybase/functions/sybase-field-seek.xml:1.2 phpdoc/en/reference/sybase/functions/sybase-field-seek.xml:1.3 --- phpdoc/en/reference/sybase/functions/sybase-field-seek.xml:1.2 Wed Apr 17 02:44:40 2002 +++ phpdoc/en/reference/sybase/functions/sybase-field-seek.xml Sat Jul 12 12:25:58 2003 @@ -1,25 +1,30 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 --> <refentry id="function.sybase-field-seek"> <refnamediv> <refname>sybase_field_seek</refname> - <refpurpose>set field offset</refpurpose> + <refpurpose>Sets field offset</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>sybase_field_seek</methodname> - <methodparam><type>int</type><parameter>result</parameter></methodparam> + <type>bool</type><methodname>sybase_field_seek</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> </methodsynopsis> <para> Seeks to the specified field offset. If the next call to <function>sybase_fetch_field</function> won't include a field - offset, this field would be returned.</para> - <para></para> + offset, this field would be returned. + </para> <para> - See also: <function>sybase_fetch_field</function>.</para> + &return.success; + </para> + <para> + See also + <function>sybase_fetch_field</function>. + </para> </refsect1> </refentry> Index: phpdoc/en/reference/sybase/functions/sybase-free-result.xml diff -u phpdoc/en/reference/sybase/functions/sybase-free-result.xml:1.2 phpdoc/en/reference/sybase/functions/sybase-free-result.xml:1.3 --- phpdoc/en/reference/sybase/functions/sybase-free-result.xml:1.2 Wed Apr 17 02:44:40 2002 +++ phpdoc/en/reference/sybase/functions/sybase-free-result.xml Sat Jul 12 12:25:58 2003 @@ -1,16 +1,16 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 --> <refentry id="function.sybase-free-result"> <refnamediv> <refname>sybase_free_result</refname> - <refpurpose>free result memory</refpurpose> + <refpurpose>Frees result memory</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>bool</type><methodname>sybase_free_result</methodname> - <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> <para> <function>sybase_free_result</function> only needs to be called Index: phpdoc/en/reference/sybase/functions/sybase-get-last-message.xml diff -u phpdoc/en/reference/sybase/functions/sybase-get-last-message.xml:1.2 phpdoc/en/reference/sybase/functions/sybase-get-last-message.xml:1.3 --- phpdoc/en/reference/sybase/functions/sybase-get-last-message.xml:1.2 Wed Apr 17 02:44:41 2002 +++ phpdoc/en/reference/sybase/functions/sybase-get-last-message.xml Sat Jul 12 12:25:58 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.9 --> <refentry id="function.sybase-get-last-message"> <refnamediv> @@ -15,6 +15,9 @@ <para> <function>sybase_get_last_message</function> returns the last message reported by the server. + </para> + <para> + See also <function>sybase_min_message_severity</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/sybase/functions/sybase-min-client-severity.xml diff -u phpdoc/en/reference/sybase/functions/sybase-min-client-severity.xml:1.2 phpdoc/en/reference/sybase/functions/sybase-min-client-severity.xml:1.3 --- phpdoc/en/reference/sybase/functions/sybase-min-client-severity.xml:1.2 Wed Apr 17 02:44:41 2002 +++ phpdoc/en/reference/sybase/functions/sybase-min-client-severity.xml Sat Jul 12 12:25:58 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.9 --> <refentry id="function.sybase-min-client-severity"> <refnamediv> @@ -23,7 +23,8 @@ </note> </para> <para> - See also: <function>sybase_min_server_severity</function>. + See also + <function>sybase_min_server_severity</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/sybase/functions/sybase-min-error-severity.xml diff -u phpdoc/en/reference/sybase/functions/sybase-min-error-severity.xml:1.2 phpdoc/en/reference/sybase/functions/sybase-min-error-severity.xml:1.3 --- phpdoc/en/reference/sybase/functions/sybase-min-error-severity.xml:1.2 Wed Apr 17 02:44:41 2002 +++ phpdoc/en/reference/sybase/functions/sybase-min-error-severity.xml Sat Jul 12 12:25:58 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.9 --> <refentry id="function.sybase-min-error-severity"> <refnamediv> @@ -17,7 +17,8 @@ error severity level. </para> <para> - See also: <function>sybase_min_message_severity</function>. + See also + <function>sybase_min_message_severity</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/sybase/functions/sybase-min-message-severity.xml diff -u phpdoc/en/reference/sybase/functions/sybase-min-message-severity.xml:1.2 phpdoc/en/reference/sybase/functions/sybase-min-message-severity.xml:1.3 --- phpdoc/en/reference/sybase/functions/sybase-min-message-severity.xml:1.2 Wed Apr 17 02:44:41 2002 +++ phpdoc/en/reference/sybase/functions/sybase-min-message-severity.xml Sat Jul 12 12:25:58 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.9 --> <refentry id="function.sybase-min-message-severity"> <refnamediv> @@ -17,7 +17,8 @@ message severity level. </para> <para> - See also: <function>sybase_min_error_severity</function>. + See also + <function>sybase_min_error_severity</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/sybase/functions/sybase-min-server-severity.xml diff -u phpdoc/en/reference/sybase/functions/sybase-min-server-severity.xml:1.2 phpdoc/en/reference/sybase/functions/sybase-min-server-severity.xml:1.3 --- phpdoc/en/reference/sybase/functions/sybase-min-server-severity.xml:1.2 Wed Apr 17 02:44:41 2002 +++ phpdoc/en/reference/sybase/functions/sybase-min-server-severity.xml Sat Jul 12 12:25:58 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.9 --> <refentry id="function.sybase-min-server-severity"> <refnamediv> @@ -23,7 +23,8 @@ </note> </para> <para> - See also: <function>sybase_min_client_severity</function>. + See also + <function>sybase_min_client_severity</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/sybase/functions/sybase-num-fields.xml diff -u phpdoc/en/reference/sybase/functions/sybase-num-fields.xml:1.2 phpdoc/en/reference/sybase/functions/sybase-num-fields.xml:1.3 --- phpdoc/en/reference/sybase/functions/sybase-num-fields.xml:1.2 Wed Apr 17 02:44:41 2002 +++ phpdoc/en/reference/sybase/functions/sybase-num-fields.xml Sat Jul 12 12:25:58 2003 @@ -1,26 +1,25 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 --> <refentry id="function.sybase-num-fields"> <refnamediv> <refname>sybase_num_fields</refname> - <refpurpose>get number of fields in result</refpurpose> + <refpurpose>Gets the number of fields in a result set</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>int</type><methodname>sybase_num_fields</methodname> - <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> <para> <function>sybase_num_fields</function> returns the number of fields in a result set. </para> <para> - See also: - <function>sybase_db_query</function>, + See also <function>sybase_query</function>, - <function>sybase_fetch_field</function>, + <function>sybase_fetch_field</function> and <function>sybase_num_rows</function>. </para> </refsect1> Index: phpdoc/en/reference/sybase/functions/sybase-num-rows.xml diff -u phpdoc/en/reference/sybase/functions/sybase-num-rows.xml:1.3 phpdoc/en/reference/sybase/functions/sybase-num-rows.xml:1.4 --- phpdoc/en/reference/sybase/functions/sybase-num-rows.xml:1.3 Wed Feb 19 17:10:28 2003 +++ phpdoc/en/reference/sybase/functions/sybase-num-rows.xml Sat Jul 12 12:25:58 2003 @@ -1,16 +1,16 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 --> <refentry id="function.sybase-num-rows"> <refnamediv> <refname>sybase_num_rows</refname> - <refpurpose>Get number of rows in result</refpurpose> + <refpurpose>Get number of rows in a result set</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>int</type><methodname>sybase_num_rows</methodname> - <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> <para> <function>sybase_num_rows</function> returns the number of rows @@ -18,8 +18,8 @@ </para> <para> See also - <function>sybase_db_query</function>, - <function>sybase_query</function>, and + <function>sybase_num_fields</function>, + <function>sybase_query</function> and <function>sybase_fetch_row</function>. </para> </refsect1> Index: phpdoc/en/reference/sybase/functions/sybase-pconnect.xml diff -u phpdoc/en/reference/sybase/functions/sybase-pconnect.xml:1.2 phpdoc/en/reference/sybase/functions/sybase-pconnect.xml:1.3 --- phpdoc/en/reference/sybase/functions/sybase-pconnect.xml:1.2 Wed Apr 17 02:44:42 2002 +++ phpdoc/en/reference/sybase/functions/sybase-pconnect.xml Sat Jul 12 12:25:58 2003 @@ -1,31 +1,35 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 --> <refentry id="function.sybase-pconnect"> <refnamediv> <refname>sybase_pconnect</refname> - <refpurpose>open persistent Sybase connection</refpurpose> + <refpurpose>Open persistent Sybase connection</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>sybase_pconnect</methodname> - <methodparam><type>string</type><parameter>servername</parameter></methodparam> - <methodparam><type>string</type><parameter>username</parameter></methodparam> - <methodparam><type>string</type><parameter>password</parameter></methodparam> + <type>resource</type><methodname>sybase_pconnect</methodname> + <methodparam choice="opt"><type>string</type><parameter>servername</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>appname</parameter></methodparam> </methodsynopsis> <para> - Returns: A positive Sybase persistent link identifier on success, - or &false; on error</para> + Returns a positive Sybase persistent link identifier on success, + or &false; on error. + </para> <para> <function>sybase_pconnect</function> acts very much like - <function>sybase_connect</function> with two major differences.</para> + <function>sybase_connect</function> with two major differences. + </para> <para> First, when connecting, the function would first try to find a (persistent) link that's already open with the same host, username and password. If one is found, an identifier for it - will be returned instead of opening a new connection.</para> + will be returned instead of opening a new connection. + </para> <para> Second, the connection to the SQL server will not be closed when the execution of the script ends. Instead, the link will remain @@ -34,6 +38,9 @@ </para> <para> This type of links is therefore called 'persistent'. + </para> + <para> + See also <function>sybase_connect</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/sybase/functions/sybase-query.xml diff -u phpdoc/en/reference/sybase/functions/sybase-query.xml:1.9 phpdoc/en/reference/sybase/functions/sybase-query.xml:1.10 --- phpdoc/en/reference/sybase/functions/sybase-query.xml:1.9 Thu Jun 12 05:56:00 2003 +++ phpdoc/en/reference/sybase/functions/sybase-query.xml Sat Jul 12 12:25:58 2003 @@ -1,19 +1,20 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 --> <refentry id="function.sybase-query"> <refnamediv> <refname>sybase_query</refname> - <refpurpose>Sends Sybase query</refpurpose> + <refpurpose>Sends a Sybase query</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>sybase_query</methodname> + <type>resource</type><methodname>sybase_query</methodname> <methodparam><type>string</type><parameter>query</parameter></methodparam> - <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> - <para> Returns: A positive Sybase result identifier on success, or + <para> + Returns a positive Sybase result identifier on success, or &false; on error. </para> <para> @@ -26,8 +27,7 @@ </para> <para> See also - <function>sybase_db_query</function>, - <function>sybase_select_db</function>, and + <function>sybase_select_db</function> and <function>sybase_connect</function>. </para> </refsect1> Index: phpdoc/en/reference/sybase/functions/sybase-result.xml diff -u phpdoc/en/reference/sybase/functions/sybase-result.xml:1.2 phpdoc/en/reference/sybase/functions/sybase-result.xml:1.3 --- phpdoc/en/reference/sybase/functions/sybase-result.xml:1.2 Wed Apr 17 02:44:42 2002 +++ phpdoc/en/reference/sybase/functions/sybase-result.xml Sat Jul 12 12:25:58 2003 @@ -1,21 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 --> <refentry id="function.sybase-result"> <refnamediv> <refname>sybase_result</refname> - <refpurpose>get result data</refpurpose> + <refpurpose>Get result data</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>string</type><methodname>sybase_result</methodname> - <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam><type>int</type><parameter>row</parameter></methodparam> <methodparam><type>mixed</type><parameter>field</parameter></methodparam> </methodsynopsis> - <para> Returns: The contents of the cell at the row and offset in - the specified Sybase result set. + <para> + Returns the contents of the cell at the row and offset in + the specified Sybase result set. </para> <para> <function>sybase_result</function> returns the contents of one @@ -37,7 +38,7 @@ <para> Recommended high-performance alternatives: <function>sybase_fetch_row</function>, - <function>sybase_fetch_array</function>, and + <function>sybase_fetch_array</function> and <function>sybase_fetch_object</function>. </para> </refsect1> Index: phpdoc/en/reference/sybase/functions/sybase-select-db.xml diff -u phpdoc/en/reference/sybase/functions/sybase-select-db.xml:1.3 phpdoc/en/reference/sybase/functions/sybase-select-db.xml:1.4 --- phpdoc/en/reference/sybase/functions/sybase-select-db.xml:1.3 Wed Jan 29 16:08:33 2003 +++ phpdoc/en/reference/sybase/functions/sybase-select-db.xml Sat Jul 12 12:25:58 2003 @@ -1,17 +1,17 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 --> <refentry id="function.sybase-select-db"> <refnamediv> <refname>sybase_select_db</refname> - <refpurpose>select Sybase database</refpurpose> + <refpurpose>Selects a Sybase database</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>bool</type><methodname>sybase_select_db</methodname> <methodparam><type>string</type><parameter>database_name</parameter></methodparam> - <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> <function>sybase_select_db</function> sets the current active @@ -22,15 +22,16 @@ called, and use it. </para> <para> - &return.success; + &return.success; </para> <para> Every subsequent call to <function>sybase_query</function> will be made on the active database. </para> - <para> See also: + <para> + See also <function>sybase_connect</function>, - <function>sybase_pconnect</function>, and + <function>sybase_pconnect</function> and <function>sybase_query</function> </para> </refsect1> Index: phpdoc/en/reference/sybase/functions/sybase-set-message-handler.xml diff -u phpdoc/en/reference/sybase/functions/sybase-set-message-handler.xml:1.3 phpdoc/en/reference/sybase/functions/sybase-set-message-handler.xml:1.4 --- phpdoc/en/reference/sybase/functions/sybase-set-message-handler.xml:1.3 Mon Jun 9 15:17:06 2003 +++ phpdoc/en/reference/sybase/functions/sybase-set-message-handler.xml Sat Jul 12 12:25:58 2003 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.sybase-set-message-handler"> <refnamediv> <refname>sybase_set_message_handler</refname> - <refpurpose>set handler called when a server message is raised</refpurpose> + <refpurpose>Sets the handler called when a server message is raised</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -18,17 +18,18 @@ method name. </para> <para> - The handler expects five arguments in the following order: message - number, severity, state, line number and description. The first four are - integers. The last is a string. If the function returns &false;, PHP - generates an ordinary error message. + The handler expects five arguments in the following order: message + number, severity, state, line number and description. The first four are + integers. The last is a string. If the function returns &false;, PHP + generates an ordinary error message. </para> <para> &return.success; </para> - <example> - <title><function>sybase_set_message_handler</function> callback function</title> - <programlisting role="php"> + <para> + <example> + <title><function>sybase_set_message_handler</function> callback function</title> + <programlisting role="php"> <![CDATA[ <?php function msg_handler($msgnumber, $severity, $state, $line, $text) { @@ -38,11 +39,11 @@ sybase_set_message_handler('msg_handler'); ?> ]]> - </programlisting> - </example> - <example> - <title><function>sybase_set_message_handler</function> callback to a class</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title><function>sybase_set_message_handler</function> callback to a class</title> + <programlisting role="php"> <![CDATA[ <?php class Sybase { @@ -55,11 +56,11 @@ sybase_set_message_handler(array($sybase, 'handler')); ?> ]]> - </programlisting> - </example> - <example> - <title><function>sybase_set_message_handler</function> unhandled messages</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title><function>sybase_set_message_handler</function> unhandled messages</title> + <programlisting role="php"> <![CDATA[ <?php // Return FALSE from this function to indicate you can't handle @@ -73,8 +74,9 @@ sybase_set_message_handler('msg_handler'); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> </refentry> Index: phpdoc/en/reference/sybase/functions/sybase-unbuffered-query.xml diff -u phpdoc/en/reference/sybase/functions/sybase-unbuffered-query.xml:1.3 phpdoc/en/reference/sybase/functions/sybase-unbuffered-query.xml:1.4 --- phpdoc/en/reference/sybase/functions/sybase-unbuffered-query.xml:1.3 Mon Jun 9 15:17:06 2003 +++ phpdoc/en/reference/sybase/functions/sybase-unbuffered-query.xml Sat Jul 12 12:25:58 2003 @@ -1,19 +1,20 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.sybase-unbuffered-query"> <refnamediv> <refname>sybase_unbuffered_query</refname> - <refpurpose>send Sybase query and do not block</refpurpose> + <refpurpose>Send a Sybase query and do not block</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>resource</type><methodname>sybase_unbuffered_query</methodname> <methodparam><type>string</type><parameter>query</parameter></methodparam> - <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> - <para> Returns: A positive Sybase result identifier on success, or - &false; on error. + <para> + Returns a positive Sybase result identifier on success, or + &false; on error. </para> <para> <function>sybase_unbuffered_query</function> sends a query to the @@ -49,9 +50,10 @@ the resultsets should'nt be fetched into memory, thus minimizing memory usage which is particularily interesting with very large resultsets. </para> - <example> - <title><function>sybase_unbuffered_query</function></title> - <programlisting role="php"> + <para> + <example> + <title><function>sybase_unbuffered_query</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $dbh= sybase_connect('SYBASE', '', ''); @@ -66,8 +68,9 @@ sybase_close($dbh); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> </refentry>