cvs: phpdoc /en/reference/ifx/functions ifx-affected-rows.xml ifx-blobinfile-mode.xml ifx-byteasvarchar.xml ifx-close.xml ifx-connect.xml
ifx-copy-blob.xml ifx-create-blob.xml ifx-create-char.xml ifx-do.xml ifx-error.xml ifx-errormsg.xml ifx-fetch-row.xml ifx-fieldproperties.xml
ifx-fieldtypes.xml ifx-free-blob.xml ifx-free-char.xml ifx-free-result.xml ifx-get-blob.xml ifx-get-char.xml ifx-getsqlca.xml ifx-htmltbl-result.xml
ifx-nullformat.xml ifx-num-fields.xml ifx-num-rows.xml ifx-pconnect.xml ifx-prepare.xml ifx-query.xml ifx-textasvarchar.xml ifx-update-blob.xml
ifx-update-char.xml ifxus-close-slob.xml ifxus-create-slob.xml ifxus-free-slob.xml ifxus-open-slob.xml ifxus-read-slob.xml ifxus-seek-slob.xml
ifxus-tell-slob.xml ifxus-write-slob.xml

didou Sat Feb 3 03:11:13 2007 UTC Modified files: /phpdoc/en/reference/ifx/functions ifx-affected-rows.xml ifx-blobinfile-mode.xml ifx-byteasvarchar.xml ifx-close.xml ifx-connect.xml ifx-copy-blob.xml ifx-create-blob.xml ifx-create-char.xml ifx-do.xml ifx-error.xml ifx-errormsg.xml ifx-fetch-row.xml ifx-fieldproperties.xml ifx-fieldtypes.xml ifx-free-blob.xml ifx-free-char.xml ifx-free-result.xml ifx-get-blob.xml ifx-get-char.xml ifx-getsqlca.xml ifx-htmltbl-result.xml ifx-nullformat.xml ifx-num-fields.xml ifx-num-rows.xml ifx-pconnect.xml ifx-prepare.xml ifx-query.xml ifx-textasvarchar.xml ifx-update-blob.xml ifx-update-char.xml ifxus-close-slob.xml ifxus-create-slob.xml ifxus-free-slob.xml ifxus-open-slob.xml ifxus-read-slob.xml ifxus-seek-slob.xml ifxus-tell-slob.xml ifxus-write-slob.xml Log: ref.ifx: switch to new doc style

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-affected-rows.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-affected-rows.xml diff -u phpdoc/en/reference/ifx/functions/ifx-affected-rows.xml:1.7 phpdoc/en/reference/ifx/functions/ifx-affected-rows.xml:1.8 --- phpdoc/en/reference/ifx/functions/ifx-affected-rows.xml:1.7 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-affected-rows.xml Sat Feb 3 03:11:12 2007 @@ -1,22 +1,18 @@ <?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>. </para> @@ -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 @@ </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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-blobinfile-mode.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-blobinfile-mode.xml diff -u phpdoc/en/reference/ifx/functions/ifx-blobinfile-mode.xml:1.4 phpdoc/en/reference/ifx/functions/ifx-blobinfile-mode.xml:1.5 --- phpdoc/en/reference/ifx/functions/ifx-blobinfile-mode.xml:1.4 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-blobinfile-mode.xml Sat Feb 3 03:11:12 2007 @@ -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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-byteasvarchar.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-byteasvarchar.xml diff -u phpdoc/en/reference/ifx/functions/ifx-byteasvarchar.xml:1.4 phpdoc/en/reference/ifx/functions/ifx-byteasvarchar.xml:1.5 --- phpdoc/en/reference/ifx/functions/ifx-byteasvarchar.xml:1.4 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-byteasvarchar.xml Sat Feb 3 03:11:12 2007 @@ -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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-close.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-close.xml diff -u phpdoc/en/reference/ifx/functions/ifx-close.xml:1.6 phpdoc/en/reference/ifx/functions/ifx-close.xml:1.7 --- phpdoc/en/reference/ifx/functions/ifx-close.xml:1.6 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-close.xml Sat Feb 3 03:11:12 2007 @@ -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 @@ </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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-connect.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-connect.xml diff -u phpdoc/en/reference/ifx/functions/ifx-connect.xml:1.5 phpdoc/en/reference/ifx/functions/ifx-connect.xml:1.6 --- phpdoc/en/reference/ifx/functions/ifx-connect.xml:1.5 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-connect.xml Sat Feb 3 03:11:12 2007 @@ -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. + 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> - 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>. + 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 @@ </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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-copy-blob.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-copy-blob.xml diff -u phpdoc/en/reference/ifx/functions/ifx-copy-blob.xml:1.3 phpdoc/en/reference/ifx/functions/ifx-copy-blob.xml:1.4 --- phpdoc/en/reference/ifx/functions/ifx-copy-blob.xml:1.3 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-copy-blob.xml Sat Feb 3 03:11:12 2007 @@ -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> + <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 &false; on error otherwise the new blob object-id. + Returns the new blob object-id, or &false; on errors. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-create-blob.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-create-blob.xml diff -u phpdoc/en/reference/ifx/functions/ifx-create-blob.xml:1.4 phpdoc/en/reference/ifx/functions/ifx-create-blob.xml:1.5 --- phpdoc/en/reference/ifx/functions/ifx-create-blob.xml:1.4 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-create-blob.xml Sat Feb 3 03:11:12 2007 @@ -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. + <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> - Return &false; on error, otherwise the new blob object-id. + Returns the new BLOB object-id, or &false; on errors. </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-create-char.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-create-char.xml diff -u phpdoc/en/reference/ifx/functions/ifx-create-char.xml:1.4 phpdoc/en/reference/ifx/functions/ifx-create-char.xml:1.5 --- phpdoc/en/reference/ifx/functions/ifx-create-char.xml:1.4 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-create-char.xml Sat Feb 3 03:11:12 2007 @@ -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. + Creates an char object. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Return &false; on error, otherwise the new char object id. + <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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-do.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-do.xml diff -u phpdoc/en/reference/ifx/functions/ifx-do.xml:1.6 phpdoc/en/reference/ifx/functions/ifx-do.xml:1.7 --- phpdoc/en/reference/ifx/functions/ifx-do.xml:1.6 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-do.xml Sat Feb 3 03:11:12 2007 @@ -1,20 +1,18 @@ <?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> <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> + <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> - See also: <function>ifx_prepare</function>. + <simplelist> + <member><function>ifx_prepare</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-error.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-error.xml diff -u phpdoc/en/reference/ifx/functions/ifx-error.xml:1.4 phpdoc/en/reference/ifx/functions/ifx-error.xml:1.5 --- phpdoc/en/reference/ifx/functions/ifx-error.xml:1.4 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-error.xml Sat Feb 3 03:11:12 2007 @@ -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> + <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> - x [SQLSTATE = aa bbb SQLCODE=cccc] + 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> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-errormsg.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-errormsg.xml diff -u phpdoc/en/reference/ifx/functions/ifx-errormsg.xml:1.6 phpdoc/en/reference/ifx/functions/ifx-errormsg.xml:1.7 --- phpdoc/en/reference/ifx/functions/ifx-errormsg.xml:1.6 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-errormsg.xml Sat Feb 3 03:11:12 2007 @@ -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 @@ </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> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-fetch-row.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-fetch-row.xml diff -u phpdoc/en/reference/ifx/functions/ifx-fetch-row.xml:1.7 phpdoc/en/reference/ifx/functions/ifx-fetch-row.xml:1.8 --- phpdoc/en/reference/ifx/functions/ifx-fetch-row.xml:1.7 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-fetch-row.xml Sat Feb 3 03:11:12 2007 @@ -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> - 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!). + 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> - <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. + <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> - <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. + 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> - 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. + 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. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Informix fetch rows</title> @@ -80,6 +106,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-fieldproperties.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-fieldproperties.xml diff -u phpdoc/en/reference/ifx/functions/ifx-fieldproperties.xml:1.7 phpdoc/en/reference/ifx/functions/ifx-fieldproperties.xml:1.8 --- phpdoc/en/reference/ifx/functions/ifx-fieldproperties.xml:1.7 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-fieldproperties.xml Sat Feb 3 03:11:12 2007 @@ -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 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-fieldtypes.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-fieldtypes.xml diff -u phpdoc/en/reference/ifx/functions/ifx-fieldtypes.xml:1.7 phpdoc/en/reference/ifx/functions/ifx-fieldtypes.xml:1.8 --- phpdoc/en/reference/ifx/functions/ifx-fieldtypes.xml:1.7 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-fieldtypes.xml Sat Feb 3 03:11:12 2007 @@ -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> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-free-blob.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-free-blob.xml diff -u phpdoc/en/reference/ifx/functions/ifx-free-blob.xml:1.5 phpdoc/en/reference/ifx/functions/ifx-free-blob.xml:1.6 --- phpdoc/en/reference/ifx/functions/ifx-free-blob.xml:1.5 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-free-blob.xml Sat Feb 3 03:11:12 2007 @@ -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> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-free-char.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-free-char.xml diff -u phpdoc/en/reference/ifx/functions/ifx-free-char.xml:1.5 phpdoc/en/reference/ifx/functions/ifx-free-char.xml:1.6 --- phpdoc/en/reference/ifx/functions/ifx-free-char.xml:1.5 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-free-char.xml Sat Feb 3 03:11:12 2007 @@ -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> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-free-result.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-free-result.xml diff -u phpdoc/en/reference/ifx/functions/ifx-free-result.xml:1.5 phpdoc/en/reference/ifx/functions/ifx-free-result.xml:1.6 --- phpdoc/en/reference/ifx/functions/ifx-free-result.xml:1.5 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-free-result.xml Sat Feb 3 03:11:12 2007 @@ -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> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-get-blob.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-get-blob.xml diff -u phpdoc/en/reference/ifx/functions/ifx-get-blob.xml:1.4 phpdoc/en/reference/ifx/functions/ifx-get-blob.xml:1.5 --- phpdoc/en/reference/ifx/functions/ifx-get-blob.xml:1.4 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-get-blob.xml Sat Feb 3 03:11:12 2007 @@ -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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-get-char.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-get-char.xml diff -u phpdoc/en/reference/ifx/functions/ifx-get-char.xml:1.4 phpdoc/en/reference/ifx/functions/ifx-get-char.xml:1.5 --- phpdoc/en/reference/ifx/functions/ifx-get-char.xml:1.4 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-get-char.xml Sat Feb 3 03:11:12 2007 @@ -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> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-getsqlca.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-getsqlca.xml diff -u phpdoc/en/reference/ifx/functions/ifx-getsqlca.xml:1.7 phpdoc/en/reference/ifx/functions/ifx-getsqlca.xml:1.8 --- phpdoc/en/reference/ifx/functions/ifx-getsqlca.xml:1.7 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-getsqlca.xml Sat Feb 3 03:11:12 2007 @@ -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> + <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> - 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. + 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> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-htmltbl-result.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-htmltbl-result.xml diff -u phpdoc/en/reference/ifx/functions/ifx-htmltbl-result.xml:1.8 phpdoc/en/reference/ifx/functions/ifx-htmltbl-result.xml:1.9 --- phpdoc/en/reference/ifx/functions/ifx-htmltbl-result.xml:1.8 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-htmltbl-result.xml Sat Feb 3 03:11:12 2007 @@ -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> + <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> - 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 + 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> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-nullformat.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-nullformat.xml diff -u phpdoc/en/reference/ifx/functions/ifx-nullformat.xml:1.4 phpdoc/en/reference/ifx/functions/ifx-nullformat.xml:1.5 --- phpdoc/en/reference/ifx/functions/ifx-nullformat.xml:1.4 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-nullformat.xml Sat Feb 3 03:11:12 2007 @@ -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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-num-fields.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-num-fields.xml diff -u phpdoc/en/reference/ifx/functions/ifx-num-fields.xml:1.4 phpdoc/en/reference/ifx/functions/ifx-num-fields.xml:1.5 --- phpdoc/en/reference/ifx/functions/ifx-num-fields.xml:1.4 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-num-fields.xml Sat Feb 3 03:11:12 2007 @@ -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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-num-rows.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-num-rows.xml diff -u phpdoc/en/reference/ifx/functions/ifx-num-rows.xml:1.4 phpdoc/en/reference/ifx/functions/ifx-num-rows.xml:1.5 --- phpdoc/en/reference/ifx/functions/ifx-num-rows.xml:1.4 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-num-rows.xml Sat Feb 3 03:11:12 2007 @@ -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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-pconnect.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-pconnect.xml diff -u phpdoc/en/reference/ifx/functions/ifx-pconnect.xml:1.4 phpdoc/en/reference/ifx/functions/ifx-pconnect.xml:1.5 --- phpdoc/en/reference/ifx/functions/ifx-pconnect.xml:1.4 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-pconnect.xml Sat Feb 3 03:11:12 2007 @@ -1,12 +1,13 @@ <?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> @@ -14,10 +15,6 @@ <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. </para> @@ -36,8 +33,61 @@ <para> This type of links is therefore called 'persistent'. </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: valid Informix persistent link identifier on success, or &false; + on errors. + </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> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-prepare.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-prepare.xml diff -u phpdoc/en/reference/ifx/functions/ifx-prepare.xml:1.5 phpdoc/en/reference/ifx/functions/ifx-prepare.xml:1.6 --- phpdoc/en/reference/ifx/functions/ifx-prepare.xml:1.5 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-prepare.xml Sat Feb 3 03:11:12 2007 @@ -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> + <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> - 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 a valid result identifier for use by <function>ifx_do</function>, + or &false; on errors. </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>ifx_do</function>. + <simplelist> + <member><function>ifx_do</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-query.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-query.xml diff -u phpdoc/en/reference/ifx/functions/ifx-query.xml:1.9 phpdoc/en/reference/ifx/functions/ifx-query.xml:1.10 --- phpdoc/en/reference/ifx/functions/ifx-query.xml:1.9 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-query.xml Sat Feb 3 03:11:12 2007 @@ -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,57 +16,90 @@ <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. - </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. --> - </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. - </para> - <para> - 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 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. - </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. - </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). + For "select-type" queries a cursor is declared and opened. + Non-select queries are "execute immediate". </para> <para> + 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 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> + 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> + <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> + Returns valid Informix result identifier on success, or &false; on errors. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> <example> <title> Show all rows of the "orders" table as a HTML table @@ -115,10 +149,17 @@ </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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-textasvarchar.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-textasvarchar.xml diff -u phpdoc/en/reference/ifx/functions/ifx-textasvarchar.xml:1.4 phpdoc/en/reference/ifx/functions/ifx-textasvarchar.xml:1.5 --- phpdoc/en/reference/ifx/functions/ifx-textasvarchar.xml:1.4 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-textasvarchar.xml Sat Feb 3 03:11:12 2007 @@ -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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-update-blob.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-update-blob.xml diff -u phpdoc/en/reference/ifx/functions/ifx-update-blob.xml:1.6 phpdoc/en/reference/ifx/functions/ifx-update-blob.xml:1.7 --- phpdoc/en/reference/ifx/functions/ifx-update-blob.xml:1.6 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-update-blob.xml Sat Feb 3 03:11:12 2007 @@ -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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-update-char.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifx-update-char.xml diff -u phpdoc/en/reference/ifx/functions/ifx-update-char.xml:1.6 phpdoc/en/reference/ifx/functions/ifx-update-char.xml:1.7 --- phpdoc/en/reference/ifx/functions/ifx-update-char.xml:1.6 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifx-update-char.xml Sat Feb 3 03:11:12 2007 @@ -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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifxus-close-slob.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifxus-close-slob.xml diff -u phpdoc/en/reference/ifx/functions/ifxus-close-slob.xml:1.5 phpdoc/en/reference/ifx/functions/ifxus-close-slob.xml:1.6 --- phpdoc/en/reference/ifx/functions/ifxus-close-slob.xml:1.5 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifxus-close-slob.xml Sat Feb 3 03:11:12 2007 @@ -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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifxus-create-slob.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifxus-create-slob.xml diff -u phpdoc/en/reference/ifx/functions/ifxus-create-slob.xml:1.3 phpdoc/en/reference/ifx/functions/ifxus-create-slob.xml:1.4 --- phpdoc/en/reference/ifx/functions/ifxus-create-slob.xml:1.3 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifxus-create-slob.xml Sat Feb 3 03:11:12 2007 @@ -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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifxus-free-slob.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifxus-free-slob.xml diff -u phpdoc/en/reference/ifx/functions/ifxus-free-slob.xml:1.5 phpdoc/en/reference/ifx/functions/ifxus-free-slob.xml:1.6 --- phpdoc/en/reference/ifx/functions/ifxus-free-slob.xml:1.5 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifxus-free-slob.xml Sat Feb 3 03:11:12 2007 @@ -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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifxus-open-slob.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifxus-open-slob.xml diff -u phpdoc/en/reference/ifx/functions/ifxus-open-slob.xml:1.4 phpdoc/en/reference/ifx/functions/ifxus-open-slob.xml:1.5 --- phpdoc/en/reference/ifx/functions/ifxus-open-slob.xml:1.4 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifxus-open-slob.xml Sat Feb 3 03:11:12 2007 @@ -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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifxus-read-slob.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifxus-read-slob.xml diff -u phpdoc/en/reference/ifx/functions/ifxus-read-slob.xml:1.5 phpdoc/en/reference/ifx/functions/ifxus-read-slob.xml:1.6 --- phpdoc/en/reference/ifx/functions/ifxus-read-slob.xml:1.5 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifxus-read-slob.xml Sat Feb 3 03:11:12 2007 @@ -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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifxus-seek-slob.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifxus-seek-slob.xml diff -u phpdoc/en/reference/ifx/functions/ifxus-seek-slob.xml:1.4 phpdoc/en/reference/ifx/functions/ifxus-seek-slob.xml:1.5 --- phpdoc/en/reference/ifx/functions/ifxus-seek-slob.xml:1.4 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifxus-seek-slob.xml Sat Feb 3 03:11:12 2007 @@ -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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifxus-tell-slob.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifxus-tell-slob.xml diff -u phpdoc/en/reference/ifx/functions/ifxus-tell-slob.xml:1.4 phpdoc/en/reference/ifx/functions/ifxus-tell-slob.xml:1.5 --- phpdoc/en/reference/ifx/functions/ifxus-tell-slob.xml:1.4 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifxus-tell-slob.xml Sat Feb 3 03:11:12 2007 @@ -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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifxus-write-slob.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ifx/functions/ifxus-write-slob.xml diff -u phpdoc/en/reference/ifx/functions/ifxus-write-slob.xml:1.5 phpdoc/en/reference/ifx/functions/ifxus-write-slob.xml:1.6 --- phpdoc/en/reference/ifx/functions/ifxus-write-slob.xml:1.5 Sat Feb 3 03:10:46 2007 +++ phpdoc/en/reference/ifx/functions/ifxus-write-slob.xml Sat Feb 3 03:11:12 2007 @@ -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