ref.sybase: new doc style

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@237704 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-06-15 00:16:45 +00:00
parent 16fe2685e8
commit 04c949f0b7
25 changed files with 1146 additions and 311 deletions

View file

@ -1,14 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.12 $ -->
<refentry id="function.sybase-affected-rows">
<refnamediv>
<refname>sybase_affected_rows</refname>
<refpurpose>Gets number of affected rows in last query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>sybase_affected_rows</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
@ -16,9 +16,40 @@
<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.
server associated with the specified link identifier.
</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>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
If the link identifier isn't specified, the last opened link is assumed.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of affected rows, as an integer.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Delete-Query</title>
@ -43,15 +74,17 @@ Records deleted: 10
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<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>.
</para>
<para>
See also <function>sybase_num_rows</function>.
<simplelist>
<member><function>sybase_num_rows</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.sybase-close">
<refnamediv>
<refname>sybase_close</refname>
<refpurpose>Closes a Sybase connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>sybase_close</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
@ -16,11 +16,6 @@
<function>sybase_close</function> closes the link to a Sybase
database that's associated with the specified link
<parameter>link_identifier</parameter>.
If the link identifier isn't specified, the last opened link is
assumed.
</para>
<para>
&return.success;
</para>
<para>
Note that this isn't usually necessary, as non-persistent
@ -31,12 +26,42 @@
<function>sybase_close</function> will not close persistent links
generated by <function>sybase_pconnect</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also
<function>sybase_connect</function> and
<function>sybase_pconnect</function>.
<variablelist>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
If the link identifier isn't specified, the last opened link is
assumed.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>sybase_connect</function></member>
<member><function>sybase_pconnect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.sybase-connect">
<refnamediv>
<refname>sybase_connect</refname>
<refpurpose>Opens a Sybase server connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>sybase_connect</methodname>
<methodparam choice="opt"><type>string</type><parameter>servername</parameter></methodparam>
@ -16,14 +16,9 @@
<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 failure.
</para>
<para>
<function>sybase_connect</function> establishes a connection to a
Sybase server. The servername argument has to be a valid
servername that is defined in the 'interfaces' file.
Sybase server.
</para>
<para>
In case a second call is made to
@ -36,6 +31,65 @@
execution of the script ends, unless it's closed earlier by
explicitly calling <function>sybase_close</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>servername</parameter></term>
<listitem>
<para>
The servername argument has to be a valid servername that is defined
in the 'interfaces' file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<para>
Sybase user name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
Password associated with <parameter>username</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>charset</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>appname</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a positive Sybase link identifier on success, or &false; on
failure.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>sybase_connect</function> example</title>
@ -51,12 +105,18 @@ sybase_close($link);
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also
<function>sybase_pconnect</function> and
<function>sybase_close</function>.
<simplelist>
<member><function>sybase_pconnect</function></member>
<member><function>sybase_close</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,32 +1,64 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.sybase-data-seek">
<refnamediv>
<refname>sybase_data_seek</refname>
<refpurpose>Moves internal row pointer</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>sybase_data_seek</methodname>
<methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam>
<methodparam><type>int</type><parameter>row_number</parameter></methodparam>
</methodsynopsis>
<para>
&return.success;
</para>
<para>
<function>sybase_data_seek</function> moves the internal row
pointer of the Sybase result associated with the specified result
identifier to pointer to the specified row number. The next call
to <function>sybase_fetch_row</function> would return that row.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also
<function>sybase_fetch_row</function>.
<variablelist>
<varlistentry>
<term><parameter>result_identifier</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>row_number</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>sybase_fetch_row</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<refentry id="function.sybase-deadlock-retry-count">
<refnamediv>
<refname>sybase_deadlock_retry_count</refname>
<refpurpose>Sets the deadlock retry count</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>sybase_deadlock_retry_count</methodname>
<methodparam><type>int</type><parameter>retry_count</parameter></methodparam>
@ -18,31 +19,54 @@
executing script is killed (for instance, by <function>set_time_limit</function>)
or the query succeeds.
</para>
</refsect1>
&sybase.ct.only;
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<table>
<title>Values for retry_count</title>
<tgroup cols="2">
<tbody>
<row>
<entry>-1</entry>
<entry>Retry forever (default)</entry>
</row>
<row>
<entry>0</entry>
<entry>Do not retry</entry>
</row>
<row>
<entry>n</entry>
<entry>Retry n times</entry>
</row>
</tbody>
</tgroup>
</table>
<variablelist>
<varlistentry>
<term><parameter>retry_count</parameter></term>
<listitem>
<para>
<table>
<title>Values for retry_count</title>
<tgroup cols="2">
<tbody>
<row>
<entry>-1</entry>
<entry>Retry forever (default)</entry>
</row>
<row>
<entry>0</entry>
<entry>Do not retry</entry>
</row>
<row>
<entry>n</entry>
<entry>Retry n times</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&sybase.ct.only;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,21 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.sybase-fetch-array">
<refnamediv>
<refname>sybase_fetch_array</refname>
<refpurpose>Fetch row as array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>sybase_fetch_array</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>
<para>
<function>sybase_fetch_array</function> is an extended version of
<function>sybase_fetch_row</function>. In addition to storing the
@ -28,13 +24,40 @@
slower than using <function>sybase_fetch_row</function>, while it
provides a significant added value.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array that corresponds to the fetched row, or &false; if there
are no more rows.
</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.
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>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Identical fieldnames</title>
@ -69,13 +92,19 @@ array(4) {
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also
<function>sybase_fetch_row</function>,
<function>sybase_fetch_assoc</function> and
<function>sybase_fetch_object</function>.
<simplelist>
<member><function>sybase_fetch_row</function></member>
<member><function>sybase_fetch_assoc</function></member>
<member><function>sybase_fetch_object</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,23 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.sybase-fetch-assoc">
<refnamediv>
<refname>sybase_fetch_assoc</refname>
<refpurpose>Fetch a result row as an associative array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<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>
&sybase.ct.only;
<para>
<function>sybase_fetch_assoc</function> is a version of
<function>sybase_fetch_row</function> that uses column names
@ -31,13 +25,47 @@
slower than using <function>sybase_fetch_row</function>, while it
provides a significant added value.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also
<function>sybase_fetch_array</function>,
<function>sybase_fetch_object</function> and
<function>sybase_fetch_row</function>.
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array that corresponds to the fetched row, or &false; if there
are no more rows.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&sybase.ct.only;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>sybase_fetch_row</function></member>
<member><function>sybase_fetch_array</function></member>
<member><function>sybase_fetch_object</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,26 +1,52 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.sybase-fetch-field">
<refnamediv>
<refname>sybase_fetch_field</refname>
<refpurpose>Get field information from a result</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>object</type><methodname>sybase_fetch_field</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>field_offset</parameter></methodparam>
</methodsynopsis>
<para>
Returns an object containing field information.
</para>
<para>
<function>sybase_fetch_field</function> can be used in order to
obtain information about fields in a certain query result. If
the field offset isn't specified, the next field that wasn't yet
retrieved by <function>sybase_fetch_field</function> is retrieved.
obtain information about fields in a certain query result.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field_offset</parameter></term>
<listitem>
<para>
If the field offset isn't specified, the next field that wasn't yet
retrieved by <function>sybase_fetch_field</function> is retrieved.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an object containing field information.
</para>
<para>
The properties of the object are:
@ -53,10 +79,17 @@
</simpara>
</listitem>
</itemizedlist>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>sybase_field_seek</function>.
<simplelist>
<member><function>sybase_field_seek</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,39 +1,81 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.sybase-fetch-object">
<refnamediv>
<refname>sybase_fetch_object</refname>
<refpurpose>Fetch a row as an object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<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
fetched row, or &false; if there are no more rows.
</para>
<para>
<function>sybase_fetch_object</function> is similar to
<function>sybase_fetch_assoc</function>, with one difference - an object
is returned, instead of an array.
</para>
<para>
Use the second <parameter>object</parameter> to specify the type of object
you want to return. If this parameter is omitted, the object will be of
type stdClass.
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>
<note>
<para>
As of PHP 4.3.0, this function will no longer return numeric object members.
</para>
<para>
Old behaviour:
<screen>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>object</parameter></term>
<listitem>
<para>
Use the second <parameter>object</parameter> to specify the type of object
you want to return. If this parameter is omitted, the object will be of
type stdClass.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an object with properties that correspond to the fetched row, or
&false; if there are no more rows.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>4.3.0</entry>
<entry>
This function will no longer return numeric object members.
Old behaviour:
<screen>
<![CDATA[
object(stdclass)(3) {
[0]=>
@ -46,9 +88,9 @@ object(stdclass)(3) {
string(3) "bar"
}
]]>
</screen>
New behaviour:
<screen>
</screen>
New behaviour:
<screen>
<![CDATA[
object(stdclass)(3) {
["foo"]=>
@ -57,9 +99,17 @@ object(stdclass)(3) {
string(3) "bar"
}
]]>
</screen>
</para>
</note>
</screen>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>sybase_fetch_object</function> return as Foo</title>
@ -80,17 +130,18 @@ object(stdclass)(3) {
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<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
<function>sybase_fetch_row</function>.
<simplelist>
<member><function>sybase_fetch_array</function></member>
<member><function>sybase_fetch_row</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,32 +1,50 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.sybase-fetch-row">
<refnamediv>
<refname>sybase_fetch_row</refname>
<refpurpose>Get a result row as an enumerated array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>sybase_fetch_row</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>
<para>
<function>sybase_fetch_row</function> fetches one row of data
from the result associated with the specified result identifier.
The row is returned as an array. Each result column is stored in
an array offset, starting at offset 0.
</para>
<para>
Subsequent call to <function>sybase_fetch_row</function> would
return the next row in the result set, or &false; if there are no
more rows.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array that corresponds to the fetched row, or &false; if there
are no more rows. Each result column is stored in an array offset,
starting at offset 0.
</para>
<table>
<title>Data types</title>
<tgroup cols="2">
@ -56,15 +74,21 @@
</tbody>
</tgroup>
</table>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
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>.
<simplelist>
<member><function>sybase_fetch_array</function></member>
<member><function>sybase_fetch_assoc</function></member>
<member><function>sybase_fetch_object</function></member>
<member><function>sybase_data_seek</function></member>
<member><function>sybase_result</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.sybase-field-seek">
<refnamediv>
<refname>sybase_field_seek</refname>
<refpurpose>Sets field offset</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>sybase_field_seek</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
@ -18,14 +18,46 @@
<function>sybase_fetch_field</function> won't include a field
offset, this field would be returned.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field_offset</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also
<function>sybase_fetch_field</function>.
<simplelist>
<member><function>sybase_fetch_field</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.sybase-free-result">
<refnamediv>
<refname>sybase_free_result</refname>
<refpurpose>Frees result memory</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>sybase_free_result</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
@ -21,6 +21,29 @@
result memory will be freed.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.9 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.sybase-get-last-message">
<refnamediv>
<refname>sybase_get_last_message</refname>
<refpurpose>Returns the last message from the server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>sybase_get_last_message</methodname>
<void/>
@ -16,10 +16,24 @@
<function>sybase_get_last_message</function> returns the last
message reported by the server.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
See also <function>sybase_min_message_severity</function>.
Returns the message as a string.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>sybase_min_message_severity</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.9 -->
<!-- $Revision: 1.9 $ -->
<refentry id="function.sybase-min-client-severity">
<refnamediv>
<refname>sybase_min_client_severity</refname>
<refpurpose>Sets minimum client severity</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>sybase_min_client_severity</methodname>
<methodparam><type>int</type><parameter>severity</parameter></methodparam>
@ -16,14 +16,44 @@
<function>sybase_min_client_severity</function> sets the minimum
client severity level.
</para>
</refsect1>
&sybase.ct.only;
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also
<function>sybase_min_server_severity</function>.
<variablelist>
<varlistentry>
<term><parameter>severity</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&sybase.ct.only;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>sybase_min_server_severity</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.9 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.sybase-min-error-severity">
<refnamediv>
<refname>sybase_min_error_severity</refname>
<refpurpose>Sets minimum error severity</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>sybase_min_error_severity</methodname>
<methodparam><type>int</type><parameter>severity</parameter></methodparam>
@ -16,14 +16,44 @@
<function>sybase_min_error_severity</function> sets the minimum
error severity level.
</para>
</refsect1>
&sybase.db.only;
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also
<function>sybase_min_message_severity</function>.
<variablelist>
<varlistentry>
<term><parameter>severity</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&sybase.ct.only;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>sybase_min_message_severity</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.9 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.sybase-min-message-severity">
<refnamediv>
<refname>sybase_min_message_severity</refname>
<refpurpose>Sets minimum message severity</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>sybase_min_message_severity</methodname>
<methodparam><type>int</type><parameter>severity</parameter></methodparam>
@ -16,14 +16,44 @@
<function>sybase_min_message_severity</function> sets the minimum
message severity level.
</para>
</refsect1>
&sybase.db.only;
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also
<function>sybase_min_error_severity</function>.
<variablelist>
<varlistentry>
<term><parameter>severity</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&sybase.db.only;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>sybase_min_error_severity</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.9 -->
<!-- $Revision: 1.9 $ -->
<refentry id="function.sybase-min-server-severity">
<refnamediv>
<refname>sybase_min_server_severity</refname>
<refpurpose>Sets minimum server severity</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>sybase_min_server_severity</methodname>
<methodparam><type>int</type><parameter>severity</parameter></methodparam>
@ -16,14 +16,44 @@
<function>sybase_min_server_severity</function> sets the minimum
server severity level.
</para>
</refsect1>
&sybase.ct.only;
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also
<function>sybase_min_client_severity</function>.
<variablelist>
<varlistentry>
<term><parameter>severity</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&sybase.ct.only;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>sybase_min_client_severity</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,28 +1,56 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.sybase-num-fields">
<refnamediv>
<refname>sybase_num_fields</refname>
<refpurpose>Gets the number of fields in a result set</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>sybase_num_fields</methodname>
<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_query</function>,
<function>sybase_fetch_field</function> and
<function>sybase_num_rows</function>.
<function>sybase_num_fields</function> returns the number of fields in a
result set.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of fields as an integer.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>sybase_query</function></member>
<member><function>sybase_fetch_field</function></member>
<member><function>sybase_num_rows</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,28 +1,56 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.sybase-num-rows">
<refnamediv>
<refname>sybase_num_rows</refname>
<refpurpose>Get number of rows in a result set</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>sybase_num_rows</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
<function>sybase_num_rows</function> returns the number of rows
in a result set.
</para>
<para>
See also
<function>sybase_num_fields</function>,
<function>sybase_query</function> and
<function>sybase_fetch_row</function>.
<function>sybase_num_rows</function> returns the number of rows in a
result set.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of rows as an integer.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>sybase_num_fields</function></member>
<member><function>sybase_query</function></member>
<member><function>sybase_fetch_row</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.sybase-pconnect">
<refnamediv>
<refname>sybase_pconnect</refname>
<refpurpose>Open persistent Sybase connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>sybase_pconnect</methodname>
<methodparam choice="opt"><type>string</type><parameter>servername</parameter></methodparam>
@ -16,10 +16,6 @@
<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>
<para>
<function>sybase_pconnect</function> acts very much like
<function>sybase_connect</function> with two major differences.
@ -39,10 +35,72 @@
<para>
This type of links is therefore called 'persistent'.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>sybase_connect</function>.
<variablelist>
<varlistentry>
<term><parameter>servername</parameter></term>
<listitem>
<para>
The servername argument has to be a valid servername that is defined
in the 'interfaces' file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<para>
Sybase user name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
Password associated with <parameter>username</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>charset</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>appname</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a positive Sybase persistent link identifier on success, or
&false; on error.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>sybase_connect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,36 +1,68 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.15 $ -->
<refentry id="function.sybase-query">
<refnamediv>
<refname>sybase_query</refname>
<refpurpose>Sends a Sybase query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>sybase_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
<function>sybase_query</function> sends a query to the currently
active database on the server that's associated with the specified
link identifier.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
If the link identifier isn't specified, the last opened link is
assumed. If no link is open, the function tries to establish a link as
if <function>sybase_connect</function> was called, and use it.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a positive Sybase result identifier on success, &false; on error,
or &true; if the query was successful but didn't return any columns.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<function>sybase_query</function> sends a query to the currently
active database on the server that's associated with the specified
link identifier. If the link identifier isn't specified, the last
opened link is assumed. If no link is open, the function tries to
establish a link as if <function>sybase_connect</function> was
called, and use it.
</para>
<para>
See also
<function>sybase_select_db</function> and
<function>sybase_connect</function>.
<simplelist>
<member><function>sybase_select_db</function></member>
<member><function>sybase_connect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.sybase-result">
<refnamediv>
<refname>sybase_result</refname>
<refpurpose>Get result data</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>sybase_result</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
@ -18,14 +18,6 @@
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
cell from a Sybase result set. The field argument can be the
field's offset, or the field's name, or the field's table dot
field's name (tablename.fieldname). If the column name has been
aliased ('select foo as bar from...'), use the alias instead of
the column name.
</para>
<para>
When working on large result sets, you should consider using one
of the functions that fetch an entire row (specified below). As
@ -42,6 +34,48 @@
<function>sybase_fetch_object</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>row</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>
<para>
The field argument can be the field's offset, or the field's name, or
the field's table dot field's name (tablename.fieldname). If the
column name has been aliased ('select foo as bar from...'), use the
alias instead of the column name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>sybase_result</function> returns the contents of one cell from a
Sybase result set.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.sybase-select-db">
<refnamediv>
<refname>sybase_select_db</refname>
<refpurpose>Selects a Sybase database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>sybase_select_db</methodname>
<methodparam><type>string</type><parameter>database_name</parameter></methodparam>
@ -16,25 +16,57 @@
<para>
<function>sybase_select_db</function> sets the current active
database on the server that's associated with the specified link
identifier. If no link identifier is specified, the last opened
link is assumed. If no link is open, the function will try to
establish a link as if <function>sybase_connect</function> was
called, and use it.
</para>
<para>
&return.success;
identifier.
</para>
<para>
Every subsequent call to <function>sybase_query</function> will be
made on the active database.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also
<function>sybase_connect</function>,
<function>sybase_pconnect</function> and
<function>sybase_query</function>
<variablelist>
<varlistentry>
<term><parameter>database_name</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
If no link identifier is specified, the last opened link is assumed.
If no link is open, the function will try to establish a link as if
<function>sybase_connect</function> was called, and use it.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>sybase_connect</function></member>
<member><function>sybase_pconnect</function></member>
<member><function>sybase_query</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.12 $ -->
<!-- $Revision: 1.13 $ -->
<refentry id="function.sybase-set-message-handler">
<refnamediv>
<refname>sybase_set_message_handler</refname>
<refpurpose>Sets the handler called when a server message is raised</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>sybase_set_message_handler</methodname>
<methodparam><type>callback</type><parameter>handler</parameter></methodparam>
@ -18,24 +19,67 @@
global function, or use an array to specify an object reference and a
method name.
</para>
</refsect1>
&sybase.ct.only;
<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.
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>handler</parameter></term>
<listitem>
<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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
<note>
<para>
The <parameter>connection</parameter> parameter was added in
PHP 4.3.5.
</para>
</note>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>4.3.5</entry>
<entry>
The <parameter>connection</parameter> parameter was added.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>sybase_set_message_handler</function> callback function</title>
@ -93,6 +137,12 @@
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&sybase.ct.only;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,25 +1,19 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.13 $ -->
<!-- $Revision: 1.14 $ -->
<refentry id="function.sybase-unbuffered-query">
<refnamediv>
<refname>sybase_unbuffered_query</refname>
<refpurpose>Send a Sybase query and do not block</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>sybase_unbuffered_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>store_result</parameter></methodparam>
</methodsynopsis>
<para>
Returns a positive Sybase result identifier on success, or
&false; on error.
</para>
&sybase.ct.only;
<para>
<function>sybase_unbuffered_query</function> sends a query to the
currently active database on the server that's associated with the specified
@ -49,11 +43,51 @@
results of an unbuffered query.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
The optional <parameter>store_result</parameter> can be &false; to indicate
the resultsets shouldn't be fetched into memory, thus minimizing memory usage
which is particularly interesting with very large resultsets.
<variablelist>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>store_result</parameter></term>
<listitem>
<para>
The optional <parameter>store_result</parameter> can be &false; to
indicate the resultsets shouldn't be fetched into memory, thus
minimizing memory usage which is particularly interesting with very
large resultsets.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a positive Sybase result identifier on success, or &false; on
error.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>sybase_unbuffered_query</function> example</title>
@ -81,11 +115,22 @@ sybase_close($dbh);
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&sybase.ct.only;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also
<function>sybase_query</function>.
<simplelist>
<member><function>sybase_query</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file