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

ref.ifx: switch to new doc style

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228815 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-02-03 03:11:12 +00:00
parent eb3e286e06
commit a228c23391
38 changed files with 1431 additions and 361 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
reference/ifx/functions/ifx-affected-rows.xml
View file

@ -1,21 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.ifx-affected-rows">
<refnamediv>
<refname>ifx_affected_rows</refname>
<refpurpose>Get number of rows affected by a query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ifx_affected_rows</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
</methodsynopsis>
<para>
<parameter>result_id</parameter> is a valid result id returned by
<function>ifx_query</function> or
<function>ifx_prepare</function>.
</para>
<para>
Returns the number of rows affected by a query associated with
<parameter>result_id</parameter>.
@ -33,6 +29,34 @@
Useful after <function>ifx_prepare</function> to limit queries to
reasonable result sets.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
A valid result id returned by <function>ifx_query</function> or
<function>ifx_prepare</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of rows as an integer.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Informix affected rows</title>
@ -54,10 +78,17 @@ if ($rowcount > 1000) {
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>ifx_num_rows</function>.
<simplelist>
<member><function>ifx_num_rows</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

33
reference/ifx/functions/ifx-blobinfile-mode.xml
View file

@ -1,25 +1,46 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ifx-blobinfile-mode">
<refnamediv>
<refname>ifx_blobinfile_mode</refname>
<refpurpose>Set the default blob mode for all select queries</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ifx_blobinfile_mode</methodname>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
Set the default blob mode for all select queries. Mode "0" means
save Byte-Blobs in memory, and mode "1" means save Byte-Blobs in
a file.
Set the default blob mode for all select queries.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
Mode "0" means save Byte-Blobs in memory, and mode "1" means save
Byte-Blobs in a file.
</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

33
reference/ifx/functions/ifx-byteasvarchar.xml
View file

@ -1,25 +1,46 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ifx-byteasvarchar">
<refnamediv>
<refname>ifx_byteasvarchar</refname>
<refpurpose>Set the default byte mode</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ifx_byteasvarchar</methodname>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
Sets the default byte mode for all select-queries. Mode "0" will
return a blob id, and mode "1" will return a varchar with text
content.
Sets the default byte mode for all select-queries.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
Mode "0" will return a blob id, and mode "1" will return a varchar
with text content.
</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

51
reference/ifx/functions/ifx-close.xml
View file

@ -1,24 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.ifx-close">
<refnamediv>
<refname>ifx_close</refname>
<refpurpose>Close Informix connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ifx_close</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
&return.success;
</para>
<para>
<function>ifx_close</function> closes the link to an Informix
database that's associated with the specified link identifier.
If the link identifier isn't specified, the last opened link is
assumed.
</para>
<para>
Note that this isn't usually necessary, as non-persistent open
@ -29,6 +25,34 @@
<function>ifx_close</function> will not close persistent links
generated by <function>ifx_pconnect</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
The link identifier. If not 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="examples">
&reftitle.examples;
<para>
<example>
<title>Closing a Informix connection</title>
@ -43,11 +67,18 @@ ifx_close($conn_id);
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>ifx_connect</function> and
<function>ifx_pconnect</function>.
<simplelist>
<member><function>ifx_connect</function></member>
<member><function>ifx_pconnect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

93
reference/ifx/functions/ifx-connect.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ifx-connect">
<refnamediv>
<refname>ifx_connect</refname>
<refpurpose>Open Informix server connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>ifx_connect</methodname>
<methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam>
@ -14,30 +15,69 @@
<methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
Returns a connection identifier on success, or &false; on
error.
<function>ifx_connect</function> establishes a connection to an Informix
server.
</para>
<para>
<function>ifx_connect</function> establishes a connection to an
Informix server. All of the arguments are optional, and if
they're missing, defaults are taken from values supplied in <link
linkend="configuration.file">configuration file</link>
(ifx.default_host for the host (Informix libraries will use
<envar>INFORMIXSERVER</envar> environment value if not defined),
ifx.default_user for user, ifx.default_password for the password
(none if not defined).
In case a second call is made to <function>ifx_connect</function> with the
same arguments, no new link will be established, but instead, the link
identifier of the already opened link will be returned.
</para>
<para>
In case a second call is made to
<function>ifx_connect</function> with the same arguments, no
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
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>ifx_close</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
All of the arguments are optional, and if they're missing, defaults are
taken from values supplied in &php.ini; (ifx.default_host for the host
(Informix libraries will use <envar>INFORMIXSERVER</envar> environment
value if not defined), ifx.default_user for user, ifx.default_password for
the password (none if not defined).
</para>
<para>
<variablelist>
<varlistentry>
<term><parameter>database</parameter></term>
<listitem>
<para>
The database name, as a string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>userid</parameter></term>
<listitem>
<para>
The username, as a string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The password, as a string.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a connection identifier on success, or &false; on error.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Connect to a Informix database</title>
@ -50,11 +90,18 @@ $conn_id = ifx_connect ("mydb@ol_srv1", "imyself", "mypassword");
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>ifx_pconnect</function> and
<function>ifx_close</function>.
<simplelist>
<member><function>ifx_pconnect</function></member>
<member><function>ifx_close</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

32
reference/ifx/functions/ifx-copy-blob.xml
View file

@ -1,22 +1,42 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.ifx-copy-blob">
<refnamediv>
<refname>ifx_copy_blob</refname>
<refpurpose>Duplicates the given blob object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ifx_copy_blob</methodname>
<methodparam><type>int</type><parameter>bid</parameter></methodparam>
</methodsynopsis>
<para>
Duplicates the given blob object. <parameter>bid</parameter> is
the ID of the blob object.
Duplicates the given blob object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
Returns &false; on error otherwise the new blob object-id.
<variablelist>
<varlistentry>
<term><parameter>bid</parameter></term>
<listitem>
<para>
A BLOB identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the new blob object-id, or &false; on errors.
</para>
</refsect1>
</refentry>

59
reference/ifx/functions/ifx-create-blob.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ifx-create-blob">
<refnamediv>
<refname>ifx_create_blob</refname>
<refpurpose>Creates an blob object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ifx_create_blob</methodname>
<methodparam><type>int</type><parameter>type</parameter></methodparam>
@ -16,21 +17,49 @@
<para>
Creates a blob object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
type: 1 = TEXT, 0 = BYTE
</para>
<para>
mode: 0 = blob-object holds the content in memory,
1 = blob-object holds the content in file.
</para>
<para>
param: if mode = 0: pointer to the content,
if mode = 1: pointer to the filestring.
</para>
<para>
Return &false; on error, otherwise the new blob object-id.
<variablelist>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>
1 = TEXT, 0 = BYTE
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
0 = blob-object holds the content in memory,
1 = blob-object holds the content in file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>param</parameter></term>
<listitem>
<para>
if mode = 0: pointer to the content,
if mode = 1: pointer to the filestring.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the new BLOB object-id, or &false; on errors.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

37
reference/ifx/functions/ifx-create-char.xml
View file

@ -1,24 +1,45 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ifx-create-char">
<refnamediv>
<refname>ifx_create_char</refname>
<refpurpose>Creates an char object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ifx_create_char</methodname>
<methodparam><type>string</type><parameter>param</parameter></methodparam>
</methodsynopsis>
<para>
Creates an char object. <parameter>param</parameter> should
be the char content.
</para>
<para>
Return &false; on error, otherwise the new char object id.
Creates an char object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>param</parameter></term>
<listitem>
<para>
The char content.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the new char object id, or &false; on errors.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

45
reference/ifx/functions/ifx-do.xml
View file

@ -1,19 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.ifx-do">
<refnamediv>
<refname>ifx_do</refname>
<refpurpose>Execute a previously prepared SQL-statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ifx_do</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
</methodsynopsis>
<para>
&return.success;
</para>
<para>
Executes a previously prepared query or opens a cursor for it.
</para>
@ -23,10 +21,41 @@
<para>
Also sets the real number of
<function>ifx_affected_rows</function> for non-select statements
for retrieval by <function>ifx_affected_rows</function>
for retrieval by <function>ifx_affected_rows</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also: <function>ifx_prepare</function>.
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
<parameter>result_id</parameter> is a valid resultid returned by
<function>ifx_query</function> or
<function>ifx_prepare</function> (select type queries only!).
</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>ifx_prepare</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

56
reference/ifx/functions/ifx-error.xml
View file

@ -1,22 +1,45 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ifx-error">
<refnamediv>
<refname>ifx_error</refname>
<refpurpose>Returns error code of last Informix call</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ifx_error</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection_id</parameter></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
The Informix error codes (SQLSTATE &amp; SQLCODE) formatted as
follows :
Returns in a string one character describing the general results of a
statement and both SQLSTATE and SQLCODE associated with the most recent
SQL statement executed.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
x [SQLSTATE = aa bbb SQLCODE=cccc]
<variablelist>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
The link identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The Informix error codes (SQLSTATE &amp; SQLCODE) formatted as
<literal>x [SQLSTATE = aa bbb SQLCODE=cccc]</literal>.
</para>
<para>
where x = space : no error
@ -41,19 +64,14 @@
See the Informix manual for the description of SQLSTATE and
SQLCODE
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
Returns in a string one character describing the general results
of a statement and both SQLSTATE and SQLCODE associated with the
most recent SQL statement executed. The format of the string is
"(char) [SQLSTATE=(two digits) (three digits) SQLCODE=(one
digit)]". The first character can be '<literal> </literal>'
(space) (success), '<literal>W</literal>' (the statement caused
some warning), '<literal>E</literal>' (an error happened when
executing the statement) or '<literal>N</literal>' (the statement
didn't return any data).
</para>
<para>
See also: <function>ifx_errormsg</function>
<simplelist>
<member><function>ifx_errormsg</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

49
reference/ifx/functions/ifx-errormsg.xml
View file

@ -1,22 +1,49 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.ifx-errormsg">
<refnamediv>
<refname>ifx_errormsg</refname>
<refpurpose>Returns error message of last Informix call</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ifx_errormsg</methodname>
<methodparam choice="opt"><type>int</type><parameter>errorcode</parameter></methodparam>
</methodsynopsis>
<para>
Returns the Informix error message associated with the most
recent Informix error, or, when the optional
<parameter>errorcode</parameter> parameter is present, the error
message corresponding to <parameter>errorcode</parameter>.
Returns the Informix error message associated with the most recent
Informix error.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>errorcode</parameter></term>
<listitem>
<para>
If specified, the function will return the message corresponding to
the specified code.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Return the error message, as a string.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ifx_errormsg</function> example</title>
@ -27,8 +54,14 @@ printf("%s\n&lt;br>", ifx_errormsg(-201));
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>ifx_error</function>.
<simplelist>
<member><function>ifx_error</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

85
reference/ifx/functions/ifx-fetch-row.xml
View file

@ -1,50 +1,76 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.ifx-fetch-row">
<refnamediv>
<refname>ifx_fetch_row</refname>
<refpurpose>Get row as enumerated array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>ifx_fetch_row</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>position</parameter></methodparam>
</methodsynopsis>
<para>
Returns an associative array that corresponds to the fetched row,
or &false; if there are no more rows.
Fetches one row of data from the result associated with the specified
result identifier.
</para>
<para>
Subsequent calls to <function>ifx_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_id</parameter></term>
<listitem>
<para>
<parameter>result_id</parameter> is a valid resultid returned by
<function>ifx_query</function> or
<function>ifx_prepare</function> (select type queries only!).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>position</parameter></term>
<listitem>
<para>
An optional parameter for a "fetch" operation on "scroll" cursors:
<literal>NEXT</literal>, <literal>PREVIOUS</literal>,
<literal>CURRENT</literal>, <literal>FIRST</literal>,
<literal>LAST</literal> or a number. If you specify a number, an
"absolute" row fetch is executed. This parameter is optional, and
only valid for SCROLL cursors.
</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, with the column name as key.
</para>
<para>
Blob columns are returned as integer blob id values for use in
<function>ifx_get_blob</function> unless you have used
ifx_textasvarchar(1) or ifx_byteasvarchar(1), in which case blobs
are returned as string values. Returns &false; on error
</para>
<para>
<parameter>result_id</parameter> is a valid resultid returned by
<function>ifx_query</function> or
<function>ifx_prepare</function> (select type queries only!).
</para>
<para>
<parameter>position</parameter> is an
optional parameter for a "fetch" operation on "scroll" cursors:
"NEXT", "PREVIOUS", "CURRENT", "FIRST", "LAST" or a number. If
you specify a number, an "absolute" row fetch is executed. This
parameter is optional, and only valid for SCROLL cursors.
</para>
<para>
<function>ifx_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, with the column name as key.
</para>
<para>
Subsequent calls to <function>ifx_fetch_row</function> would
return the next row in the result set, or &false; if there are no
more rows.
are returned as string values.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Informix fetch rows</title>
@ -80,6 +106,7 @@ ifx_free_result ($rid);
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

44
reference/ifx/functions/ifx-fieldproperties.xml
View file

@ -1,27 +1,54 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.ifx-fieldproperties">
<refnamediv>
<refname>ifx_fieldproperties</refname>
<refpurpose>List of SQL fieldproperties</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>ifx_fieldproperties</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
</methodsynopsis>
<para>
Returns an associative array with fieldnames as key and the SQL
fieldproperties as data for a query with
<parameter>result_id</parameter>. Returns &false; on error.
</para>
<para>
Returns the Informix SQL fieldproperties of every field in the
query as an associative array. Properties are encoded as:
"SQLTYPE;length;precision;scale;ISNULLABLE" where SQLTYPE = the
Informix type like "SQLVCHAR" etc. and ISNULLABLE = "Y" or "N".
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
<parameter>result_id</parameter> is a valid resultid returned by
<function>ifx_query</function> or
<function>ifx_prepare</function> (select type queries only!).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an associative array with fieldnames as key and the SQL
fieldproperties as data for a query with <parameter>result_id</parameter>.
Returns &false; on errors.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Informix SQL fieldproperties</title>
@ -41,6 +68,7 @@ foreach ($properties as $fname => $val) {
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

38
reference/ifx/functions/ifx-fieldtypes.xml
View file

@ -1,21 +1,53 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.ifx-fieldtypes">
<refnamediv>
<refname>ifx_fieldtypes</refname>
<refpurpose>List of Informix SQL fields</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>ifx_fieldtypes</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
</methodsynopsis>
<para>
Returns an associative array with fieldnames as key and the SQL
fieldtypes as data for the query associated with
<parameter>result_id</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
<parameter>result_id</parameter> is a valid resultid returned by
<function>ifx_query</function> or
<function>ifx_prepare</function> (select type queries only!).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an associative array with fieldnames as key and the SQL
fieldtypes as data for query with
<parameter>result_id</parameter>. Returns &false; on error.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Fieldnames and SQL fieldtypes</title>

30
reference/ifx/functions/ifx-free-blob.xml
View file

@ -1,20 +1,40 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ifx-free-blob">
<refnamediv>
<refname>ifx_free_blob</refname>
<refpurpose>Deletes the blob object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ifx_free_blob</methodname>
<methodparam><type>int</type><parameter>bid</parameter></methodparam>
</methodsynopsis>
<para>
Deletes the blobobject for the given blob object-id
<parameter>bid</parameter>.
Deletes the blobobject for the given blob object-id.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bid</parameter></term>
<listitem>
<para>
The BLOB object id.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>

30
reference/ifx/functions/ifx-free-char.xml
View file

@ -1,20 +1,40 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ifx-free-char">
<refnamediv>
<refname>ifx_free_char</refname>
<refpurpose>Deletes the char object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ifx_free_char</methodname>
<methodparam><type>int</type><parameter>bid</parameter></methodparam>
</methodsynopsis>
<para>
Deletes the charobject for the given char object-id
<parameter>bid</parameter>.
Deletes the charobject for the given char object-id.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bid</parameter></term>
<listitem>
<para>
The char object id.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>

29
reference/ifx/functions/ifx-free-result.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ifx-free-result">
<refnamediv>
<refname>ifx_free_result</refname>
<refpurpose>Releases resources for the query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ifx_free_result</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
@ -15,6 +16,28 @@
Releases resources for the query associated with
<parameter>result_id</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
<parameter>result_id</parameter> is a valid resultid returned by
<function>ifx_query</function> or
<function>ifx_prepare</function> (select type queries only!).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>

34
reference/ifx/functions/ifx-get-blob.xml
View file

@ -1,21 +1,45 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ifx-get-blob">
<refnamediv>
<refname>ifx_get_blob</refname>
<refpurpose>Return the content of a blob object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ifx_get_blob</methodname>
<methodparam><type>int</type><parameter>bid</parameter></methodparam>
</methodsynopsis>
<para>
Returns the content of the blob object for the given blob
object-id <parameter>bid</parameter>.
Returns the content of the blob object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bid</parameter></term>
<listitem>
<para>
The BLOB object id.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The contents of the BLOB as a string, or &false; on errors.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

33
reference/ifx/functions/ifx-get-char.xml
View file

@ -1,19 +1,42 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ifx-get-char">
<refnamediv>
<refname>ifx_get_char</refname>
<refpurpose>Return the content of the char object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ifx_get_char</methodname>
<methodparam><type>int</type><parameter>bid</parameter></methodparam>
</methodsynopsis>
<para>
Returns the content of the char object for the given char
object-id <parameter>bid</parameter>.
Returns the content of the char object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bid</parameter></term>
<listitem>
<para>
The char object-id.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the contents as a string, or &false; on errors.
</para>
</refsect1>
</refentry>

62
reference/ifx/functions/ifx-getsqlca.xml
View file

@ -1,37 +1,63 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.ifx-getsqlca">
<refnamediv>
<refname>ifx_getsqlca</refname>
<refpurpose>Get the contents of sqlca.sqlerrd[0..5] after a query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>ifx_getsqlca</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
</methodsynopsis>
<para>
<parameter>result_id</parameter> is a valid result id returned by
<function>ifx_query</function> or
<function>ifx_prepare</function>.
Returns a pseudo-row with sqlca.sqlerrd[0] ... sqlca.sqlerrd[5] after the
query associated with <parameter>result_id</parameter>.
</para>
<para>
Returns a pseudo-row (associative array) with sqlca.sqlerrd[0]
... sqlca.sqlerrd[5] after the query associated with
<parameter>result_id</parameter>.
For inserts, updates and deletes the values returned are those as set by
the server after executing the query. This gives access to the number of
affected rows and the serial insert value. For <literal>SELECT</literal>s
the values are those saved after the <literal>PREPARE</literal> statement.
This gives access to the *estimated* number of affected rows. The use of
this function saves the overhead of executing a <literal>SELECT
dbinfo('sqlca.sqlerrdx')</literal> query, as it retrieves the values that
were saved by the ifx driver at the appropriate moment.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
For inserts, updates and deletes the values returned are those as
set by the server after executing the query. This gives access to
the number of affected rows and the serial insert value. For
SELECTs the values are those saved after the PREPARE
statement. This gives access to the *estimated* number of
affected rows. The use of this function saves the overhead of
executing a "select dbinfo('sqlca.sqlerrdx')" query, as it
retrieves the values that were saved by the ifx driver at the
appropriate moment.
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
<parameter>result_id</parameter> is a valid result id returned by
<function>ifx_query</function> or
<function>ifx_prepare</function> (select type queries only!).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an associative array with the following entries:
<literal>sqlerrd0</literal>, <literal>sqlerrd1</literal>,
<literal>sqlerrd2</literal>, <literal>sqlerrd3</literal>,
<literal>sqlerrd4</literal> and <literal>sqlerrd5</literal>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Retrieve Informix sqlca.sqlerrd[x] values</title>

48
reference/ifx/functions/ifx-htmltbl-result.xml
View file

@ -1,25 +1,59 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<refentry id="function.ifx-htmltbl-result">
<refnamediv>
<refname>ifx_htmltbl_result</refname>
<refpurpose>Formats all rows of a query into a HTML table</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ifx_htmltbl_result</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>html_table_options</parameter></methodparam>
</methodsynopsis>
<para>
Returns the number of rows fetched or &false; on error.
Formats and prints all rows of the <parameter>result_id</parameter> query
into a HTML table.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
Formats all rows of the <parameter>result_id</parameter> query
into a HTML table. The optional second argument is a string of
&lt;table&gt; tag options
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
<parameter>result_id</parameter> is a valid resultid returned by
<function>ifx_query</function> or
<function>ifx_prepare</function> (select type queries only!).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>html_table_options</parameter></term>
<listitem>
<para>
This optional argument is a string of &lt;table&gt; tag options.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of fetched rows, or &false; on errors.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Informix results as HTML table</title>

29
reference/ifx/functions/ifx-nullformat.xml
View file

@ -1,24 +1,45 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ifx-nullformat">
<refnamediv>
<refname>ifx_nullformat</refname>
<refpurpose>Sets the default return value on a fetch row</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ifx_nullformat</methodname>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
Sets the default return value of a NULL-value on a fetch row.
Mode "0" returns "", and mode "1" returns "&null;".
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
Mode "0" returns "", and mode "1" returns "&null;".
</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

37
reference/ifx/functions/ifx-num-fields.xml
View file

@ -1,25 +1,48 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ifx-num-fields">
<refnamediv>
<refname>ifx_num_fields</refname>
<refpurpose>Returns the number of columns in the query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ifx_num_fields</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
</methodsynopsis>
<para>
Returns the number of columns in query for
<parameter>result_id</parameter> or &false; on error
</para>
<para>
After preparing or executing a query, this call gives you the
number of columns in the query.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
<parameter>result_id</parameter> is a valid resultid returned by
<function>ifx_query</function> or
<function>ifx_prepare</function> (select type queries only!).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of columns in query for
<parameter>result_id</parameter>, or &false; on errors.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

32
reference/ifx/functions/ifx-num-rows.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ifx-num-rows">
<refnamediv>
<refname>ifx_num_rows</refname>
<refpurpose>Count the rows already fetched from a query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ifx_num_rows</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
@ -18,6 +19,31 @@
query.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
<parameter>result_id</parameter> is a valid resultid returned by
<function>ifx_query</function> or
<function>ifx_prepare</function> (select type queries only!).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of fetched rows or &false; on errors.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

66
reference/ifx/functions/ifx-pconnect.xml
View file

@ -1,22 +1,19 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ifx-pconnect">
<refnamediv>
<refname>ifx_pconnect</refname>
<refpurpose>Open persistent Informix connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>ifx_pconnect</methodname>
<methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>userid</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
Returns: valid Informix persistent link identifier on success,
or &false; on error.
</para>
<para>
<function>ifx_pconnect</function> acts very much like
<function>ifx_connect</function> with two major differences.
@ -36,8 +33,61 @@
<para>
This type of links is therefore called 'persistent'.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also: <function>ifx_connect</function>.
All of the arguments are optional, and if they're missing, defaults are
taken from values supplied in &php.ini; (ifx.default_host for the host
(Informix libraries will use <envar>INFORMIXSERVER</envar> environment
value if not defined), ifx.default_user for user, ifx.default_password for
the password (none if not defined).
</para>
<para>
<variablelist>
<varlistentry>
<term><parameter>database</parameter></term>
<listitem>
<para>
The database name, as a string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>userid</parameter></term>
<listitem>
<para>
The username, as a string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The password, as a string.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns: valid Informix persistent link identifier on success, or &false;
on errors.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ifx_connect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

108
reference/ifx/functions/ifx-prepare.xml
View file

@ -1,58 +1,108 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ifx-prepare">
<refnamediv>
<refname>ifx_prepare</refname>
<refpurpose>Prepare an SQL-statement for execution</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>ifx_prepare</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam><type>resource</type><parameter>conn_id</parameter></methodparam>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>cursor_def</parameter></methodparam>
<methodparam><type>mixed</type><parameter>blobidarray</parameter></methodparam>
</methodsynopsis>
<para>
Returns valid <parameter>result_id</parameter> for use by
<function>ifx_do</function>. Sets
<parameter>affected_rows</parameter> for retrieval by the
<function>ifx_affected_rows</function> function.
Prepares a <parameter>query</parameter> for later use with
<function>ifx_do</function>.
</para>
<para>
Prepares <parameter>query</parameter> on connection
<parameter>conn_id</parameter>. For "select-type" queries a
cursor is declared and opened. The optional
<parameter>cursor_type</parameter> parameter allows you to make
this a "scroll" and/or "hold" cursor. It's a bitmask and can be
either IFX_SCROLL, IFX_HOLD, or both or'ed together.
For "select-type" queries a cursor is declared and opened.
Non-select queries are "execute immediate".
</para>
<para>
For either query type the estimated number of affected rows is
For either query type the number of (estimated or real) affected rows is
saved for retrieval by <function>ifx_affected_rows</function>.
</para>
<para>
If you have BLOB (BYTE or TEXT) columns in the query, you can add
a <parameter>blobidarray</parameter> parameter containing the
corresponding "blob ids", and you should replace those columns
with a "?" in the query text.
If the contents of the TEXT (or BYTE) column allow it, you can also use
<literal>ifx_textasvarchar(1)</literal> and
<literal>ifx_byteasvarchar(1)</literal>. This allows you to treat TEXT
(or BYTE) columns just as if they were ordinary (but long) VARCHAR columns
for select queries, and you don't need to bother with blob id's.
</para>
<para>
If the contents of the TEXT (or BYTE) column allow it, you can
also use "ifx_textasvarchar(1)" and "ifx_byteasvarchar(1)". This
allows you to treat TEXT (or BYTE) columns just as if they were
ordinary (but long) VARCHAR columns for select queries, and you
don't need to bother with blob id's.
With <literal>ifx_textasvarchar(0)</literal> or
<literal>ifx_byteasvarchar(0)</literal> (the default situation), select
queries will return BLOB columns as blob id's (integer value). You can
get the value of the blob as a string or file with the blob functions (see
below).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
With ifx_textasvarchar(0) or ifx_byteasvarchar(0) (the default
situation), select queries will return BLOB columns as blob id's
(integer value). You can get the value of the blob as a string
or file with the blob functions (see below).
<variablelist>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
The query string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
The link identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cursor_def</parameter></term>
<listitem>
<para>
This optional parameter allows you to make this a
<literal>scroll</literal> and/or <literal>hold</literal> cursor.
It's a bitmask and can be either <constant>IFX_SCROLL</constant>,
<constant>IFX_HOLD</constant>, or both or'ed together.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>blobidarray</parameter></term>
<listitem>
<para>
If you have BLOB (BYTE or TEXT) columns in the query, you can add
a <parameter>blobidarray</parameter> parameter containing the
corresponding "blob ids", and you should replace those columns
with a "?" in the query text.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
See also: <function>ifx_do</function>.
Returns a valid result identifier for use by <function>ifx_do</function>,
or &false; on errors.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ifx_do</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

123
reference/ifx/functions/ifx-query.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- $Revision: 1.10 $ -->
<refentry id="function.ifx-query">
<refnamediv>
<refname>ifx_query</refname>
<refpurpose>Send Informix query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>ifx_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
@ -15,56 +16,89 @@
<methodparam choice="opt"><type>mixed</type><parameter>blobidarray</parameter></methodparam>
</methodsynopsis>
<para>
Returns valid Informix result identifier on success, or
&false; on error.
Sends a <parameter>query</parameter> to the currently active database on
the server that's associated with the specified link identifier.
</para>
<para>
A "result_id" resource used by other functions to retrieve the
query results. Sets "affected_rows" for retrieval by the
<function>ifx_affected_rows</function> function.
For "select-type" queries a cursor is declared and opened.
Non-select queries are "execute immediate".
</para>
<para>
<function>ifx_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>ifx_connect</function> was called, and use it. -->
For either query type the number of (estimated or real) affected rows is
saved for retrieval by <function>ifx_affected_rows</function>.
</para>
<para>
Executes <parameter>query</parameter> on connection
<parameter>conn_id</parameter>. For "select-type" queries a
cursor is declared and opened. The optional
<parameter>cursor_type</parameter> parameter allows you to make
this a "scroll" and/or "hold" cursor. It's a bitmask and can be
either IFX_SCROLL, IFX_HOLD, or both or'ed together. Non-select
queries are "execute immediate". IFX_SCROLL and IFX_HOLD are
symbolic constants and as such shouldn't be between quotes. I you
omit this parameter the cursor is a normal sequential cursor.
If the contents of the TEXT (or BYTE) column allow it, you can also use
<literal>ifx_textasvarchar(1)</literal> and
<literal>ifx_byteasvarchar(1)</literal>. This allows you to treat TEXT
(or BYTE) columns just as if they were ordinary (but long) VARCHAR columns
for select queries, and you don't need to bother with blob id's.
</para>
<para>
For either query type the number of (estimated or real) affected
rows is saved for retrieval by
<function>ifx_affected_rows</function>.
With <literal>ifx_textasvarchar(0)</literal> or
<literal>ifx_byteasvarchar(0)</literal> (the default situation), select
queries will return BLOB columns as blob id's (integer value). You can
get the value of the blob as a string or file with the blob functions (see
below).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
If you have BLOB (BYTE or TEXT) columns in an update query, you
can add a <parameter>blobidarray</parameter> parameter containing
the corresponding "blob ids", and you should replace those
columns with a "?" in the query text.
<variablelist>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
The query string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
The link identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cursor_def</parameter></term>
<listitem>
<para>
This optional parameter allows you to make this a
<literal>scroll</literal> and/or <literal>hold</literal> cursor.
It's a bitmask and can be either <constant>IFX_SCROLL</constant>,
<constant>IFX_HOLD</constant>, or both or'ed together. I you omit this
parameter the cursor is a normal sequential cursor.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>blobidarray</parameter></term>
<listitem>
<para>
If you have BLOB (BYTE or TEXT) columns in the query, you can add
a <parameter>blobidarray</parameter> parameter containing the
corresponding "blob ids", and you should replace those columns
with a "?" in the query text.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
If the contents of the TEXT (or BYTE) column allow it, you can
also use "ifx_textasvarchar(1)" and "ifx_byteasvarchar(1)". This
allows you to treat TEXT (or BYTE) columns just as if they were
ordinary (but long) VARCHAR columns for select queries, and you
don't need to bother with blob id's.
</para><para>
With ifx_textasvarchar(0) or ifx_byteasvarchar(0) (the default
situation), select queries will return BLOB columns as blob id's
(integer value). You can get the value of the blob as a string
or file with the blob functions (see below).
Returns valid Informix result identifier on success, or &false; on errors.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>
@ -115,10 +149,17 @@ ifx_free_result($res_id);
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>ifx_connect</function>.
<simplelist>
<member><function>ifx_connect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

33
reference/ifx/functions/ifx-textasvarchar.xml
View file

@ -1,25 +1,46 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ifx-textasvarchar">
<refnamediv>
<refname>ifx_textasvarchar</refname>
<refpurpose>Set the default text mode</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ifx_textasvarchar</methodname>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
Sets the default text mode for all select-queries. Mode "0" will
return a blob id, and mode "1" will return a varchar with text
content.
Sets the default text mode for all select-queries.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
Mode "0" will return a blob id, and mode "1" will return a varchar
with text content.
</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

39
reference/ifx/functions/ifx-update-blob.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.ifx-update-blob">
<refnamediv>
<refname>ifx_update_blob</refname>
<refpurpose>Updates the content of the blob object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ifx_update_blob</methodname>
<methodparam><type>int</type><parameter>bid</parameter></methodparam>
@ -14,13 +15,41 @@
</methodsynopsis>
<para>
Updates the content of the blob object for the given blob object
<parameter>bid</parameter>. <parameter>content</parameter> is a
string with new data.
<parameter>bid</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bid</parameter></term>
<listitem>
<para>
A BLOB object identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
The new data, as a string.
</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

39
reference/ifx/functions/ifx-update-char.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.ifx-update-char">
<refnamediv>
<refname>ifx_update_char</refname>
<refpurpose>Updates the content of the char object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ifx_update_char</methodname>
<methodparam><type>int</type><parameter>bid</parameter></methodparam>
@ -14,13 +15,41 @@
</methodsynopsis>
<para>
Updates the content of the char object for the given char object
<parameter>bid</parameter>. <parameter>content</parameter> is a
string with new data.
<parameter>bid</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bid</parameter></term>
<listitem>
<para>
A char object identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
The new data, as a string.
</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

28
reference/ifx/functions/ifxus-close-slob.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ifxus-close-slob">
<refnamediv>
<refname>ifxus_close_slob</refname>
<refpurpose>Deletes the slob object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ifxus_close_slob</methodname>
<methodparam><type>int</type><parameter>bid</parameter></methodparam>
@ -15,10 +16,31 @@
Deletes the slob object on the given slob object-id
<parameter>bid</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bid</parameter></term>
<listitem>
<para>
An existing slob id.
</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

40
reference/ifx/functions/ifxus-create-slob.xml
View file

@ -1,24 +1,48 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.ifxus-create-slob">
<refnamediv>
<refname>ifxus_create_slob</refname>
<refpurpose>Creates an slob object and opens it</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ifxus_create_slob</methodname>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
Creates an slob object and opens it. Modes: 1 = LO_RDONLY, 2 =
LO_WRONLY, 4 = LO_APPEND, 8 = LO_RDWR, 16 = LO_BUFFER, 32 =
LO_NOBUFFER -> or-mask. You can also use constants named
IFX_LO_RDONLY, IFX_LO_WRONLY etc. Return &false; on error otherwise
the new slob object-id.
Creates an slob object and opens it.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
A combination of <constant>IFX_LO_RDONLY</constant>,
<constant>IFX_LO_WRONLY</constant>, <constant>IFX_LO_APPEND</constant>
<constant>IFX_LO_RDWR</constant>, <constant>IFX_LO_BUFFER</constant>,
<constant>IFX_LO_NOBUFFER</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Return the new slob object-id, or &false; on errors.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

31
reference/ifx/functions/ifxus-free-slob.xml
View file

@ -1,24 +1,45 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ifxus-free-slob">
<refnamediv>
<refname>ifxus_free_slob</refname>
<refpurpose>Deletes the slob object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ifxus_free_slob</methodname>
<methodparam><type>int</type><parameter>bid</parameter></methodparam>
</methodsynopsis>
<para>
Deletes the slob object. <parameter>bid</parameter> is the Id of
the slob object.
Deletes the slob object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bid</parameter></term>
<listitem>
<para>
An existing slob id.
</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

47
reference/ifx/functions/ifxus-open-slob.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ifxus-open-slob">
<refnamediv>
<refname>ifxus_open_slob</refname>
<refpurpose>Opens an slob object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ifxus_open_slob</methodname>
<methodparam><type>int</type><parameter>bid</parameter></methodparam>
@ -14,12 +15,44 @@
</methodsynopsis>
<para>
Opens an slob object. <parameter>bid</parameter> should be an
existing slob id. Modes: 1 = LO_RDONLY, 2 = LO_WRONLY, 4 =
LO_APPEND, 8 = LO_RDWR, 16 = LO_BUFFER, 32 = LO_NOBUFFER ->
or-mask. Returns &false; on error otherwise the new slob
object-id.
existing slob id.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bid</parameter></term>
<listitem>
<para>
An existing slob id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
A combination of <constant>IFX_LO_RDONLY</constant>,
<constant>IFX_LO_WRONLY</constant>, <constant>IFX_LO_APPEND</constant>
<constant>IFX_LO_RDWR</constant>, <constant>IFX_LO_BUFFER</constant>,
<constant>IFX_LO_NOBUFFER</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the new slob object-id, or &false; on errors.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

43
reference/ifx/functions/ifxus-read-slob.xml
View file

@ -1,23 +1,54 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ifxus-read-slob">
<refnamediv>
<refname>ifxus_read_slob</refname>
<refpurpose>Reads nbytes of the slob object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ifxus_read_slob</methodname>
<methodparam><type>int</type><parameter>bid</parameter></methodparam>
<methodparam><type>int</type><parameter>nbytes</parameter></methodparam>
</methodsynopsis>
<para>
Reads nbytes of the slob object. <parameter>bid</parameter> is an
existing slob id and <parameter>nbytes</parameter> is the number
of bytes to read. Return &false; on error otherwise the string.
Reads <parameter>nbytes</parameter> of the slob object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bid</parameter></term>
<listitem>
<para>
An existing slob id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nbytes</parameter></term>
<listitem>
<para>
The number of bytes to read.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the slob contents as a string, or &false; on errors.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

51
reference/ifx/functions/ifxus-seek-slob.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ifxus-seek-slob">
<refnamediv>
<refname>ifxus_seek_slob</refname>
<refpurpose>Sets the current file or seek position</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ifxus_seek_slob</methodname>
<methodparam><type>int</type><parameter>bid</parameter></methodparam>
@ -15,12 +16,48 @@
</methodsynopsis>
<para>
Sets the current file or seek position of an open slob object.
<parameter>bid</parameter> should be an existing slob id. Modes:
0 = LO_SEEK_SET, 1 = LO_SEEK_CUR, 2 = LO_SEEK_END and
<parameter>offset</parameter> is an byte offset. Return &false; on
error otherwise the seek position.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bid</parameter></term>
<listitem>
<para>
An existing slob id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
0 = LO_SEEK_SET, 1 = LO_SEEK_CUR, 2 = LO_SEEK_END.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
A byte offset.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the seek position as an integer, or &false; on errors.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

33
reference/ifx/functions/ifxus-tell-slob.xml
View file

@ -1,22 +1,45 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ifxus-tell-slob">
<refnamediv>
<refname>ifxus_tell_slob</refname>
<refpurpose>Returns the current file or seek position</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ifxus_tell_slob</methodname>
<methodparam><type>int</type><parameter>bid</parameter></methodparam>
</methodsynopsis>
<para>
Returns the current file or seek position of an open slob object
<parameter>bid</parameter> should be an existing slob id. Return
&false; on error otherwise the seek position.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bid</parameter></term>
<listitem>
<para>
An existing slob id.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the seek position as an integer, or &false; on errors.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

43
reference/ifx/functions/ifxus-write-slob.xml
View file

@ -1,23 +1,54 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ifxus-write-slob">
<refnamediv>
<refname>ifxus_write_slob</refname>
<refpurpose>Writes a string into the slob object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ifxus_write_slob</methodname>
<methodparam><type>int</type><parameter>bid</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
<para>
Writes a string into the slob object. <parameter>bid</parameter>
is an existing slob id and <parameter>content</parameter> the
content to write. Return &false; on error otherwise bytes written.
Writes a string into the slob object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bid</parameter></term>
<listitem>
<para>
An existing slob id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
The content to write, as a string.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the bytes written as an integer, or &false; on errors.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file