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

From:	Mehdi Achour	Date:	Sat, 03 Feb 2007 03:10:47 +0000
Subject:	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
Groups:	php.doc
Request:	Send a blank email to phpdoc+get-969375178@lists.php.net to get a copy of this message

didou Sat Feb 3 03:10:47 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: WS, prepare for new doc style

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ifx/functions/ifx-affected-rows.xml?r1=1.6&r2=1.7&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.6 phpdoc/en/reference/ifx/functions/ifx-affected-rows.xml:1.7 --- phpdoc/en/reference/ifx/functions/ifx-affected-rows.xml:1.6 Fri May 5 11:41:25 2006 +++ phpdoc/en/reference/ifx/functions/ifx-affected-rows.xml Sat Feb 3 03:10:46 2007 @@ -1,46 +1,45 @@ <?xml version="1.0" encoding="iso-8859-1"?> - - - <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> - <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> - <para> - For inserts, updates and deletes the number is the real number - (sqlerrd[2]) of affected rows. For selects it is an estimate - (sqlerrd[0]). Don't rely on it. The database server can never - return the actual number of rows that will be returned by a - SELECT because it has not even begun fetching them at this stage - (just after the "PREPARE" when the optimizer has determined the - query plan). - </para> - <para> - Useful after <function>ifx_prepare</function> to limit queries to - reasonable result sets. - </para> - <para> - <example> - <title>Informix affected rows</title> - <programlisting role="php"> + +<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> + <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> + <para> + For inserts, updates and deletes the number is the real number + (sqlerrd[2]) of affected rows. For selects it is an estimate + (sqlerrd[0]). Don't rely on it. The database server can never + return the actual number of rows that will be returned by a + SELECT because it has not even begun fetching them at this stage + (just after the "PREPARE" when the optimizer has determined the + query plan). + </para> + <para> + Useful after <function>ifx_prepare</function> to limit queries to + reasonable result sets. + </para> + <para> + <example> + <title>Informix affected rows</title> + <programlisting role="php"> <![CDATA[ <?php -$rid = ifx_prepare("select * from emp +$rid = ifx_prepare("select * from emp where name like " . $name, $connid); if (! $rid) { /* ... error ... */ @@ -52,14 +51,14 @@ } ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>ifx_num_rows</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>ifx_num_rows</function>. + </para> + </refsect1> +</refentry>  - - <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> - <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. - </para> - <para> - &return.success; - </para> - </refsect1> - </refentry> + +<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> + <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. + </para> + <para> + &return.success; + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifx-byteasvarchar"> - <refnamediv> - <refname>ifx_byteasvarchar</refname> - <refpurpose>Set the default byte mode</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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. - </para> - <para> - &return.success; - </para> - </refsect1> - </refentry> + +<refentry id="function.ifx-byteasvarchar"> + <refnamediv> + <refname>ifx_byteasvarchar</refname> + <refpurpose>Set the default byte mode</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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. + </para> + <para> + &return.success; + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifx-close"> - <refnamediv> - <refname>ifx_close</refname> - <refpurpose>Close Informix connection</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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 - links are automatically closed at the end of the script's - execution. - </para> - <para> - <function>ifx_close</function> will not close persistent links - generated by <function>ifx_pconnect</function>. - </para> - <para> - <example> - <title>Closing a Informix connection</title> - <programlisting role="php"> + +<refentry id="function.ifx-close"> + <refnamediv> + <refname>ifx_close</refname> + <refpurpose>Close Informix connection</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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 + links are automatically closed at the end of the script's + execution. + </para> + <para> + <function>ifx_close</function> will not close persistent links + generated by <function>ifx_pconnect</function>. + </para> + <para> + <example> + <title>Closing a Informix connection</title> + <programlisting role="php"> <![CDATA[ <?php $conn_id = ifx_connect ("mydb@ol_srv", "itsme", "mypassword"); @@ -41,15 +40,15 @@ ifx_close($conn_id); ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>ifx_connect</function> and - <function>ifx_pconnect</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>ifx_connect</function> and + <function>ifx_pconnect</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifx-connect"> - <refnamediv> - <refname>ifx_connect</refname> - <refpurpose>Open Informix server connection</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>ifx_connect</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 a connection identifier on success, or &false; on - error. - </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). - </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 - <function>ifx_close</function>. - </para> - <para> - <example> - <title>Connect to a Informix database</title> - <programlisting role="php"> + +<refentry id="function.ifx-connect"> + <refnamediv> + <refname>ifx_connect</refname> + <refpurpose>Open Informix server connection</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>ifx_connect</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 a connection identifier on success, or &false; on + error. + </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). + </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 + <function>ifx_close</function>. + </para> + <para> + <example> + <title>Connect to a Informix database</title> + <programlisting role="php"> <![CDATA[ <?php $conn_id = ifx_connect ("mydb@ol_srv1", "imyself", "mypassword"); ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>ifx_pconnect</function> and - <function>ifx_close</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>ifx_pconnect</function> and + <function>ifx_close</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifx-copy-blob"> - <refnamediv> - <refname>ifx_copy_blob</refname> - <refpurpose>Duplicates the given blob object</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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. - </para> - <para> - Returns &false; on error otherwise the new blob object-id. - </para> - </refsect1> - </refentry> + +<refentry id="function.ifx-copy-blob"> + <refnamediv> + <refname>ifx_copy_blob</refname> + <refpurpose>Duplicates the given blob object</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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. + </para> + <para> + Returns &false; on error otherwise the new blob object-id. + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifx-create-blob"> - <refnamediv> - <refname>ifx_create_blob</refname> - <refpurpose>Creates an blob object</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>ifx_create_blob</methodname> - <methodparam><type>int</type><parameter>type</parameter></methodparam> - <methodparam><type>int</type><parameter>mode</parameter></methodparam> - <methodparam><type>string</type><parameter>param</parameter></methodparam> - </methodsynopsis> - <para> - Creates a blob object. - </para> - <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. - </para> - </refsect1> - </refentry> + +<refentry id="function.ifx-create-blob"> + <refnamediv> + <refname>ifx_create_blob</refname> + <refpurpose>Creates an blob object</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>ifx_create_blob</methodname> + <methodparam><type>int</type><parameter>type</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + <methodparam><type>string</type><parameter>param</parameter></methodparam> + </methodsynopsis> + <para> + Creates a blob object. + </para> + <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. + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifx-create-char"> - <refnamediv> - <refname>ifx_create_char</refname> - <refpurpose>Creates an char object</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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. - </para> - </refsect1> - </refentry> + +<refentry id="function.ifx-create-char"> + <refnamediv> + <refname>ifx_create_char</refname> + <refpurpose>Creates an char object</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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. + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifx-do"> - <refnamediv> - <refname>ifx_do</refname> - <refpurpose> - Execute a previously prepared SQL-statement - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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> - Does NOT free <parameter>result_id</parameter> on error. - </para> - <para> - Also sets the real number of - <function>ifx_affected_rows</function> for non-select statements - for retrieval by <function>ifx_affected_rows</function> - </para> - <para> - See also: <function>ifx_prepare</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.ifx-do"> + <refnamediv> + <refname>ifx_do</refname> + <refpurpose>Execute a previously prepared SQL-statement</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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> + Does NOT free <parameter>result_id</parameter> on error. + </para> + <para> + Also sets the real number of + <function>ifx_affected_rows</function> for non-select statements + for retrieval by <function>ifx_affected_rows</function> + </para> + <para> + See also: <function>ifx_prepare</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifx-error"> - <refnamediv> - <refname>ifx_error</refname> - <refpurpose>Returns error code of last Informix call</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>ifx_error</methodname> - <methodparam choice="opt"><type>resource</type><parameter>connection_id</parameter></methodparam> - </methodsynopsis> - <para> - The Informix error codes (SQLSTATE & SQLCODE) formatted as - follows : - </para> - <para> - x [SQLSTATE = aa bbb SQLCODE=cccc] - </para> - <para> - where x = space : no error - </para> - <para> - E : error - </para> - <para> - N : no more data - </para> - <para> - W : warning - </para> - <para> - ? : undefined - </para> - <para> - If the "x" character is anything other than space, SQLSTATE and - SQLCODE describe the error in more detail. - </para> - <para> - See the Informix manual for the description of SQLSTATE and - SQLCODE - </para> - <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> - </para> - </refsect1> - </refentry> + +<refentry id="function.ifx-error"> + <refnamediv> + <refname>ifx_error</refname> + <refpurpose>Returns error code of last Informix call</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>ifx_error</methodname> + <methodparam choice="opt"><type>resource</type><parameter>connection_id</parameter></methodparam> + </methodsynopsis> + <para> + The Informix error codes (SQLSTATE & SQLCODE) formatted as + follows : + </para> + <para> + x [SQLSTATE = aa bbb SQLCODE=cccc] + </para> + <para> + where x = space : no error + </para> + <para> + E : error + </para> + <para> + N : no more data + </para> + <para> + W : warning + </para> + <para> + ? : undefined + </para> + <para> + If the "x" character is anything other than space, SQLSTATE and + SQLCODE describe the error in more detail. + </para> + <para> + See the Informix manual for the description of SQLSTATE and + SQLCODE + </para> + <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> + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifx-errormsg"> - <refnamediv> - <refname>ifx_errormsg</refname> - <refpurpose>Returns error message of last Informix call</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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>. - </para> - <para> - <example> - <title><function>ifx_errormsg</function> example</title> - <programlisting role="php"> + +<refentry id="function.ifx-errormsg"> + <refnamediv> + <refname>ifx_errormsg</refname> + <refpurpose>Returns error message of last Informix call</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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>. + </para> + <para> + <example> + <title><function>ifx_errormsg</function> example</title> + <programlisting role="php"> <![CDATA[ printf("%s\n<br>", ifx_errormsg(-201)); ]]> - </programlisting> - </example> - </para> - <para> - See also <function>ifx_error</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>ifx_error</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifx-fetch-row"> - <refnamediv> - <refname>ifx_fetch_row</refname> - <refpurpose>Get row as enumerated array</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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. - </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. - </para> - <para> - <example> - <title>Informix fetch rows</title> - <programlisting role="php"> + +<refentry id="function.ifx-fetch-row"> + <refnamediv> + <refname>ifx_fetch_row</refname> + <refpurpose>Get row as enumerated array</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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. + </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. + </para> + <para> + <example> + <title>Informix fetch rows</title> + <programlisting role="php"> <![CDATA[ <?php $rid = ifx_prepare ("select * from emp where name like " . $name, @@ -77,11 +76,11 @@ ifx_free_result ($rid); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifx-fieldproperties"> - <refnamediv> - <refname>ifx_fieldproperties</refname> - <refpurpose>List of SQL fieldproperties</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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> - <para> - <example> - <title>Informix SQL fieldproperties</title> - <programlisting role="php"> + +<refentry id="function.ifx-fieldproperties"> + <refnamediv> + <refname>ifx_fieldproperties</refname> + <refpurpose>List of SQL fieldproperties</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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> + <para> + <example> + <title>Informix SQL fieldproperties</title> + <programlisting role="php"> <![CDATA[ <?php $properties = ifx_fieldproperties($resultid); @@ -38,11 +37,11 @@ } ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifx-fieldtypes"> - <refnamediv> - <refname>ifx_fieldtypes</refname> - <refpurpose>List of Informix SQL fields</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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 query with - <parameter>result_id</parameter>. Returns &false; on error. - </para> - <para> - <example> - <title>Fieldnames and SQL fieldtypes</title> - <programlisting role="php"> + +<refentry id="function.ifx-fieldtypes"> + <refnamediv> + <refname>ifx_fieldtypes</refname> + <refpurpose>List of Informix SQL fields</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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 query with + <parameter>result_id</parameter>. Returns &false; on error. + </para> + <para> + <example> + <title>Fieldnames and SQL fieldtypes</title> + <programlisting role="php"> <![CDATA[ <?php $types = ifx_fieldtypes($resultid); @@ -32,11 +31,11 @@ } ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifx-free-blob"> - <refnamediv> - <refname>ifx_free_blob</refname> - <refpurpose>Deletes the blob object</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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>. - </para> - <para> - &return.success; - </para> - </refsect1> - </refentry> + +<refentry id="function.ifx-free-blob"> + <refnamediv> + <refname>ifx_free_blob</refname> + <refpurpose>Deletes the blob object</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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>. + </para> + <para> + &return.success; + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifx-free-char"> - <refnamediv> - <refname>ifx_free_char</refname> - <refpurpose>Deletes the char object</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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>. - </para> - <para> - &return.success; - </para> - </refsect1> - </refentry> + +<refentry id="function.ifx-free-char"> + <refnamediv> + <refname>ifx_free_char</refname> + <refpurpose>Deletes the char object</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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>. + </para> + <para> + &return.success; + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifx-free-result"> - <refnamediv> - <refname>ifx_free_result</refname> - <refpurpose>Releases resources for the query</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ifx_free_result</methodname> - <methodparam><type>resource</type><parameter>result_id</parameter></methodparam> - </methodsynopsis> - <para> - Releases resources for the query associated with - <parameter>result_id</parameter>. - </para> - <para> - &return.success; - </para> - </refsect1> - </refentry> + +<refentry id="function.ifx-free-result"> + <refnamediv> + <refname>ifx_free_result</refname> + <refpurpose>Releases resources for the query</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ifx_free_result</methodname> + <methodparam><type>resource</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> + <para> + Releases resources for the query associated with + <parameter>result_id</parameter>. + </para> + <para> + &return.success; + </para> + </refsect1> +</refentry>  - - <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> - <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>. - </para> - </refsect1> - </refentry> + +<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> + <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>. + </para> + </refsect1> +</refentry>  - - <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> - <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>. - </para> - </refsect1> - </refentry> + +<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> + <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>. + </para> + </refsect1> +</refentry>  - - <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> - <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>. - </para> - <para> - Returns a pseudo-row (associative array) with sqlca.sqlerrd[0] - ... sqlca.sqlerrd[5] after the query associated with - <parameter>result_id</parameter>. - </para> - <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. - </para> - <para> - <example> - <title>Retrieve Informix sqlca.sqlerrd[x] values</title> - <programlisting role="php"> + +<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> + <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>. + </para> + <para> + Returns a pseudo-row (associative array) with sqlca.sqlerrd[0] + ... sqlca.sqlerrd[5] after the query associated with + <parameter>result_id</parameter>. + </para> + <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. + </para> + <para> + <example> + <title>Retrieve Informix sqlca.sqlerrd[x] values</title> + <programlisting role="php"> <![CDATA[ <?php /* assume the first column of 'sometable' is a serial */ -$qid = ifx_query("insert into sometable +$qid = ifx_query("insert into sometable values (0, '2nd column', 'another column') ", $connid); if (!$qid) { /* ... error ... */ } $sqlca = ifx_getsqlca($qid); $serial_value = $sqlca["sqlerrd1"]; -echo "The serial value of the inserted row is : $serial_value<br />\n"; +echo "The serial value of the inserted row is : $serial_value<br />\n"; ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry>  - - <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> - <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. - </para> - <para> - Formats all rows of the <parameter>result_id</parameter> query - into a HTML table. The optional second argument is a string of - <table> tag options - </para> - <para> - <example> - <title>Informix results as HTML table</title> - <programlisting role="php"> + +<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> + <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. + </para> + <para> + Formats all rows of the <parameter>result_id</parameter> query + into a HTML table. The optional second argument is a string of + <table> tag options + </para> + <para> + <example> + <title>Informix results as HTML table</title> + <programlisting role="php"> <![CDATA[ <?php $rid = ifx_prepare ("select * from emp where name like " . $name, @@ -48,11 +45,11 @@ ifx_free_result($rid); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry>  - - <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> - <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> - <para> - &return.success; - </para> - </refsect1> - </refentry> + +<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> + <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> + <para> + &return.success; + </para> + </refsect1> +</refentry>  - - <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> - <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> - </refentry> + +<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> + <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> +</refentry>  - - <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> - <methodsynopsis> - <type>int</type><methodname>ifx_num_rows</methodname> - <methodparam><type>resource</type><parameter>result_id</parameter></methodparam> - </methodsynopsis> - <para> - Gives the number of rows fetched so far for a query with - <parameter>result_id</parameter> after a - <function>ifx_query</function> or <function>ifx_do</function> - query. - </para> - </refsect1> - </refentry> + +<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> + <methodsynopsis> + <type>int</type><methodname>ifx_num_rows</methodname> + <methodparam><type>resource</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> + <para> + Gives the number of rows fetched so far for a query with + <parameter>result_id</parameter> after a + <function>ifx_query</function> or <function>ifx_do</function> + query. + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifx-pconnect"> - <refnamediv> - <refname>ifx_pconnect</refname> - <refpurpose>Open persistent Informix connection</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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. - </para> - <para> - First, when connecting, the function would first try to find a - (persistent) link that's already open with the same host, - username and password. If one is found, an identifier for it - will be returned instead of opening a new connection. - </para> - <para> - Second, the connection to the SQL server will not be closed when - the execution of the script ends. Instead, the link will remain - open for future use (<function>ifx_close</function> will not - close links established by <function>ifx_pconnect</function>). - </para> - <para> - This type of links is therefore called 'persistent'. - </para> - <para> - See also: <function>ifx_connect</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.ifx-pconnect"> + <refnamediv> + <refname>ifx_pconnect</refname> + <refpurpose>Open persistent Informix connection</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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. + </para> + <para> + First, when connecting, the function would first try to find a + (persistent) link that's already open with the same host, + username and password. If one is found, an identifier for it + will be returned instead of opening a new connection. + </para> + <para> + Second, the connection to the SQL server will not be closed when + the execution of the script ends. Instead, the link will remain + open for future use (<function>ifx_close</function> will not + close links established by <function>ifx_pconnect</function>). + </para> + <para> + This type of links is therefore called 'persistent'. + </para> + <para> + See also: <function>ifx_connect</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifx-prepare"> - <refnamediv> - <refname>ifx_prepare</refname> - <refpurpose>Prepare an SQL-statement for execution</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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 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. - </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. - </para> - <para> - For either query type the estimated number of 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. - </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). - </para> - <para> - See also: <function>ifx_do</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.ifx-prepare"> + <refnamediv> + <refname>ifx_prepare</refname> + <refpurpose>Prepare an SQL-statement for execution</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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 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. + </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. + </para> + <para> + For either query type the estimated number of 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. + </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). + </para> + <para> + See also: <function>ifx_do</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifx-query"> - <refnamediv> - <refname>ifx_query</refname> - <refpurpose>Send Informix query</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>ifx_query</methodname> - <methodparam><type>string</type><parameter>query</parameter></methodparam> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>cursor_type</parameter></methodparam> - <methodparam choice="opt"><type>mixed</type><parameter> - blobidarray - </parameter></methodparam> - </methodsynopsis> - <para> - Returns valid Informix result identifier on success, or - &false; on error. - </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.  - </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). - </para> - <para> - <example> - <title> - Show all rows of the "orders" table as a HTML table - </title> - <programlisting role="php"> + +<refentry id="function.ifx-query"> + <refnamediv> + <refname>ifx_query</refname> + <refpurpose>Send Informix query</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>ifx_query</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>cursor_type</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>blobidarray</parameter></methodparam> + </methodsynopsis> + <para> + Returns valid Informix result identifier on success, or + &false; on error. + </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.  + </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). + </para> + <para> + <example> + <title> + Show all rows of the "orders" table as a HTML table + </title> + <programlisting role="php"> <![CDATA[ <?php ifx_textasvarchar(1); // use "text mode" for blobs @@ -87,12 +84,12 @@ ifx_free_result($res_id); ?> ]]> - </programlisting> - </example> - <example> - <title>Insert some values into the "catalog" table</title> - <programlisting role="php"> -<![CDATA[ + </programlisting> + </example> + <example> + <title>Insert some values into the "catalog" table</title> + <programlisting role="php"> +<![CDATA[ <?php // create blob id's for a byte and text column @@ -115,14 +112,14 @@ ifx_free_result($res_id); ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>ifx_connect</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>ifx_connect</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifx-textasvarchar"> - <refnamediv> - <refname>ifx_textasvarchar</refname> - <refpurpose>Set the default text mode</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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. - </para> - <para> - &return.success; - </para> - </refsect1> - </refentry> + +<refentry id="function.ifx-textasvarchar"> + <refnamediv> + <refname>ifx_textasvarchar</refname> + <refpurpose>Set the default text mode</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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. + </para> + <para> + &return.success; + </para> + </refsect1> +</refentry>  - - <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> - <methodsynopsis> - <type>bool</type><methodname>ifx_update_blob</methodname> - <methodparam><type>int</type><parameter>bid</parameter></methodparam> - <methodparam><type>string</type><parameter>content</parameter></methodparam> - </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. - </para> - <para> - &return.success; - </para> - </refsect1> - </refentry> + +<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> + <methodsynopsis> + <type>bool</type><methodname>ifx_update_blob</methodname> + <methodparam><type>int</type><parameter>bid</parameter></methodparam> + <methodparam><type>string</type><parameter>content</parameter></methodparam> + </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. + </para> + <para> + &return.success; + </para> + </refsect1> +</refentry>  - - <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> - <methodsynopsis> - <type>bool</type><methodname>ifx_update_char</methodname> - <methodparam><type>int</type><parameter>bid</parameter></methodparam> - <methodparam><type>string</type><parameter>content</parameter></methodparam> - </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. - </para> - <para> - &return.success; - </para> - </refsect1> - </refentry> + +<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> + <methodsynopsis> + <type>bool</type><methodname>ifx_update_char</methodname> + <methodparam><type>int</type><parameter>bid</parameter></methodparam> + <methodparam><type>string</type><parameter>content</parameter></methodparam> + </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. + </para> + <para> + &return.success; + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifxus-close-slob"> - <refnamediv> - <refname>ifxus_close_slob</refname> - <refpurpose>Deletes the slob object</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ifxus_close_slob</methodname> - <methodparam><type>int</type><parameter>bid</parameter></methodparam> - </methodsynopsis> - <para> - Deletes the slob object on the given slob object-id - <parameter>bid</parameter>. - </para> - <para> - &return.success; - </para> - </refsect1> - </refentry> + +<refentry id="function.ifxus-close-slob"> + <refnamediv> + <refname>ifxus_close_slob</refname> + <refpurpose>Deletes the slob object</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ifxus_close_slob</methodname> + <methodparam><type>int</type><parameter>bid</parameter></methodparam> + </methodsynopsis> + <para> + Deletes the slob object on the given slob object-id + <parameter>bid</parameter>. + </para> + <para> + &return.success; + </para> + </refsect1> +</refentry>  - - <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> - <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. - </para> - </refsect1> - </refentry> + +<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> + <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. + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifxus-free-slob"> - <refnamediv> - <refname>ifxus_free_slob</refname> - <refpurpose>Deletes the slob object</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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. - </para> - <para> - &return.success; - </para> - </refsect1> - </refentry> + +<refentry id="function.ifxus-free-slob"> + <refnamediv> + <refname>ifxus_free_slob</refname> + <refpurpose>Deletes the slob object</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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. + </para> + <para> + &return.success; + </para> + </refsect1> +</refentry>  - - <refentry id="function.ifxus-open-slob"> - <refnamediv> - <refname>ifxus_open_slob</refname> - <refpurpose>Opens an slob object</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>ifxus_open_slob</methodname> - <methodparam><type>int</type><parameter>bid</parameter></methodparam> - <methodparam><type>int</type><parameter>mode</parameter></methodparam> - </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. - </para> - </refsect1> - </refentry> + +<refentry id="function.ifxus-open-slob"> + <refnamediv> + <refname>ifxus_open_slob</refname> + <refpurpose>Opens an slob object</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>ifxus_open_slob</methodname> + <methodparam><type>int</type><parameter>bid</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </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. + </para> + </refsect1> +</refentry>  - - <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> - <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. - </para> - </refsect1> - </refentry> + +<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> + <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. + </para> + </refsect1> +</refentry>  - - <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> - <methodsynopsis> - <type>int</type><methodname>ifxus_seek_slob</methodname> - <methodparam><type>int</type><parameter>bid</parameter></methodparam> - <methodparam><type>int</type><parameter>mode</parameter></methodparam> - <methodparam><type>int</type><parameter>offset</parameter></methodparam> - </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> - </refentry> + +<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> + <methodsynopsis> + <type>int</type><methodname>ifxus_seek_slob</methodname> + <methodparam><type>int</type><parameter>bid</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + <methodparam><type>int</type><parameter>offset</parameter></methodparam> + </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> +</refentry>  - - <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> - <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> - </refentry> + +<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> + <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> +</refentry>  - - <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> - <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. - </para> - </refsect1> - </refentry> + +<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> + <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. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: