From eb3e286e060193e6f21fbbdbd0fef8062d990d0b Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Sat, 3 Feb 2007 03:10:46 +0000 Subject: [PATCH] WS, prepare for new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228814 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/ifx/functions/ifx-affected-rows.xml | 95 +++++----- .../ifx/functions/ifx-blobinfile-mode.xml | 45 +++-- reference/ifx/functions/ifx-byteasvarchar.xml | 45 +++-- reference/ifx/functions/ifx-close.xml | 87 +++++---- reference/ifx/functions/ifx-connect.xml | 108 ++++++----- reference/ifx/functions/ifx-copy-blob.xml | 43 +++-- reference/ifx/functions/ifx-create-blob.xml | 67 ++++--- reference/ifx/functions/ifx-create-char.xml | 43 +++-- reference/ifx/functions/ifx-do.xml | 65 ++++--- reference/ifx/functions/ifx-error.xml | 117 ++++++------ reference/ifx/functions/ifx-errormsg.xml | 61 +++--- reference/ifx/functions/ifx-fetch-row.xml | 111 ++++++----- .../ifx/functions/ifx-fieldproperties.xml | 65 ++++--- reference/ifx/functions/ifx-fieldtypes.xml | 53 +++--- reference/ifx/functions/ifx-free-blob.xml | 43 +++-- reference/ifx/functions/ifx-free-char.xml | 43 +++-- reference/ifx/functions/ifx-free-result.xml | 43 +++-- reference/ifx/functions/ifx-get-blob.xml | 37 ++-- reference/ifx/functions/ifx-get-char.xml | 37 ++-- reference/ifx/functions/ifx-getsqlca.xml | 91 +++++---- .../ifx/functions/ifx-htmltbl-result.xml | 63 +++---- reference/ifx/functions/ifx-nullformat.xml | 45 +++-- reference/ifx/functions/ifx-num-fields.xml | 45 +++-- reference/ifx/functions/ifx-num-rows.xml | 41 ++-- reference/ifx/functions/ifx-pconnect.xml | 85 +++++---- reference/ifx/functions/ifx-prepare.xml | 115 ++++++------ reference/ifx/functions/ifx-query.xml | 175 +++++++++--------- reference/ifx/functions/ifx-textasvarchar.xml | 45 +++-- reference/ifx/functions/ifx-update-blob.xml | 47 +++-- reference/ifx/functions/ifx-update-char.xml | 47 +++-- reference/ifx/functions/ifxus-close-slob.xml | 43 +++-- reference/ifx/functions/ifxus-create-slob.xml | 43 +++-- reference/ifx/functions/ifxus-free-slob.xml | 43 +++-- reference/ifx/functions/ifxus-open-slob.xml | 45 +++-- reference/ifx/functions/ifxus-read-slob.xml | 41 ++-- reference/ifx/functions/ifxus-seek-slob.xml | 47 +++-- reference/ifx/functions/ifxus-tell-slob.xml | 39 ++-- reference/ifx/functions/ifxus-write-slob.xml | 41 ++-- 38 files changed, 1149 insertions(+), 1200 deletions(-) diff --git a/reference/ifx/functions/ifx-affected-rows.xml b/reference/ifx/functions/ifx-affected-rows.xml index f438b3e3b9..fab6794fbe 100644 --- a/reference/ifx/functions/ifx-affected-rows.xml +++ b/reference/ifx/functions/ifx-affected-rows.xml @@ -1,46 +1,45 @@ - - - - - ifx_affected_rows - Get number of rows affected by a query - - - Description - - intifx_affected_rows - resourceresult_id - - - result_id is a valid result id returned by - ifx_query or - ifx_prepare. - - - Returns the number of rows affected by a query associated with - result_id. - - - 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). - - - Useful after ifx_prepare to limit queries to - reasonable result sets. - - - - Informix affected rows - + + + + ifx_affected_rows + Get number of rows affected by a query + + + Description + + intifx_affected_rows + resourceresult_id + + + result_id is a valid result id returned by + ifx_query or + ifx_prepare. + + + Returns the number of rows affected by a query associated with + result_id. + + + 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). + + + Useful after ifx_prepare to limit queries to + reasonable result sets. + + + + Informix affected rows + 1000) { } ?> ]]> - - - - - See also ifx_num_rows. - - - + + + + + See also ifx_num_rows. + + + - - - - ifx_blobinfile_mode - Set the default blob mode for all select queries - - - Description - - boolifx_blobinfile_mode - intmode - - - 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. - - - &return.success; - - - + + + + ifx_blobinfile_mode + Set the default blob mode for all select queries + + + Description + + boolifx_blobinfile_mode + intmode + + + 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. + + + &return.success; + + + - - - - ifx_byteasvarchar - Set the default byte mode - - - Description - - boolifx_byteasvarchar - intmode - - - 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. - - - &return.success; - - - + + + + ifx_byteasvarchar + Set the default byte mode + + + Description + + boolifx_byteasvarchar + intmode + + + 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. + + + &return.success; + + + - - - - ifx_close - Close Informix connection - - - Description - - boolifx_close - resourcelink_identifier - - - &return.success; - - - ifx_close 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. - - - Note that this isn't usually necessary, as non-persistent open - links are automatically closed at the end of the script's - execution. - - - ifx_close will not close persistent links - generated by ifx_pconnect. - - - - Closing a Informix connection - + + + + ifx_close + Close Informix connection + + + Description + + boolifx_close + resourcelink_identifier + + + &return.success; + + + ifx_close 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. + + + Note that this isn't usually necessary, as non-persistent open + links are automatically closed at the end of the script's + execution. + + + ifx_close will not close persistent links + generated by ifx_pconnect. + + + + Closing a Informix connection + ]]> - - - - - See also ifx_connect and - ifx_pconnect. - - - + + + + + See also ifx_connect and + ifx_pconnect. + + + - - - - ifx_connect - Open Informix server connection - - - Description - - resourceifx_connect - stringdatabase - - stringuserid - - stringpassword - - - - Returns a connection identifier on success, or &false; on - error. - - - ifx_connect 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 configuration file - (ifx.default_host for the host (Informix libraries will use - INFORMIXSERVER 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 - ifx_connect 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 - ifx_close. - - - - Connect to a Informix database - + + + + ifx_connect + Open Informix server connection + + + Description + + resourceifx_connect + stringdatabase + stringuserid + stringpassword + + + Returns a connection identifier on success, or &false; on + error. + + + ifx_connect 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 configuration file + (ifx.default_host for the host (Informix libraries will use + INFORMIXSERVER 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 + ifx_connect 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 + ifx_close. + + + + Connect to a Informix database + ]]> - - - - - See also ifx_pconnect and - ifx_close. - - - + + + + + See also ifx_pconnect and + ifx_close. + + + - - - - ifx_copy_blob - Duplicates the given blob object - - - Description - - intifx_copy_blob - intbid - - - Duplicates the given blob object. bid is - the ID of the blob object. - - - Returns &false; on error otherwise the new blob object-id. - - - + + + + ifx_copy_blob + Duplicates the given blob object + + + Description + + intifx_copy_blob + intbid + + + Duplicates the given blob object. bid is + the ID of the blob object. + + + Returns &false; on error otherwise the new blob object-id. + + + - - - - ifx_create_blob - Creates an blob object - - - Description - - intifx_create_blob - inttype - intmode - stringparam - - - Creates a blob object. - - - type: 1 = TEXT, 0 = BYTE - - - mode: 0 = blob-object holds the content in memory, - 1 = blob-object holds the content in file. - - - param: if mode = 0: pointer to the content, - if mode = 1: pointer to the filestring. - - - Return &false; on error, otherwise the new blob object-id. - - - + + + + ifx_create_blob + Creates an blob object + + + Description + + intifx_create_blob + inttype + intmode + stringparam + + + Creates a blob object. + + + type: 1 = TEXT, 0 = BYTE + + + mode: 0 = blob-object holds the content in memory, + 1 = blob-object holds the content in file. + + + param: if mode = 0: pointer to the content, + if mode = 1: pointer to the filestring. + + + Return &false; on error, otherwise the new blob object-id. + + + - - - - ifx_create_char - Creates an char object - - - Description - - intifx_create_char - stringparam - - - Creates an char object. param should - be the char content. - - - Return &false; on error, otherwise the new char object id. - - - + + + + ifx_create_char + Creates an char object + + + Description + + intifx_create_char + stringparam + + + Creates an char object. param should + be the char content. + + + Return &false; on error, otherwise the new char object id. + + + - - - - ifx_do - - Execute a previously prepared SQL-statement - - - - Description - - boolifx_do - resourceresult_id - - - &return.success; - - - Executes a previously prepared query or opens a cursor for it. - - - Does NOT free result_id on error. - - - Also sets the real number of - ifx_affected_rows for non-select statements - for retrieval by ifx_affected_rows - - - See also: ifx_prepare. - - - + + + + ifx_do + Execute a previously prepared SQL-statement + + + Description + + boolifx_do + resourceresult_id + + + &return.success; + + + Executes a previously prepared query or opens a cursor for it. + + + Does NOT free result_id on error. + + + Also sets the real number of + ifx_affected_rows for non-select statements + for retrieval by ifx_affected_rows + + + See also: ifx_prepare. + + + - - - - ifx_error - Returns error code of last Informix call - - - Description - - stringifx_error - resourceconnection_id - - - The Informix error codes (SQLSTATE & SQLCODE) formatted as - follows : - - - x [SQLSTATE = aa bbb SQLCODE=cccc] - - - where x = space : no error - - - E : error - - - N : no more data - - - W : warning - - - ? : undefined - - - If the "x" character is anything other than space, SQLSTATE and - SQLCODE describe the error in more detail. - - - See the Informix manual for the description of SQLSTATE and - SQLCODE - - - 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 ' ' - (space) (success), 'W' (the statement caused - some warning), 'E' (an error happened when - executing the statement) or 'N' (the statement - didn't return any data). - - - See also: ifx_errormsg - - - + + + + ifx_error + Returns error code of last Informix call + + + Description + + stringifx_error + resourceconnection_id + + + The Informix error codes (SQLSTATE & SQLCODE) formatted as + follows : + + + x [SQLSTATE = aa bbb SQLCODE=cccc] + + + where x = space : no error + + + E : error + + + N : no more data + + + W : warning + + + ? : undefined + + + If the "x" character is anything other than space, SQLSTATE and + SQLCODE describe the error in more detail. + + + See the Informix manual for the description of SQLSTATE and + SQLCODE + + + 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 ' ' + (space) (success), 'W' (the statement caused + some warning), 'E' (an error happened when + executing the statement) or 'N' (the statement + didn't return any data). + + + See also: ifx_errormsg + + + - - - - ifx_errormsg - Returns error message of last Informix call - - - Description - - stringifx_errormsg - interrorcode - - - Returns the Informix error message associated with the most - recent Informix error, or, when the optional - errorcode parameter is present, the error - message corresponding to errorcode. - - - - <function>ifx_errormsg</function> example - + + + + ifx_errormsg + Returns error message of last Informix call + + + Description + + stringifx_errormsg + interrorcode + + + Returns the Informix error message associated with the most + recent Informix error, or, when the optional + errorcode parameter is present, the error + message corresponding to errorcode. + + + + <function>ifx_errormsg</function> example + ", ifx_errormsg(-201)); ]]> - - - - - See also ifx_error. - - - + + + + + See also ifx_error. + + + - - - - ifx_fetch_row - Get row as enumerated array - - - Description - - arrayifx_fetch_row - resourceresult_id - mixedposition - - - Returns an associative array that corresponds to the fetched row, - or &false; if there are no more rows. - - - Blob columns are returned as integer blob id values for use in - ifx_get_blob unless you have used - ifx_textasvarchar(1) or ifx_byteasvarchar(1), in which case blobs - are returned as string values. Returns &false; on error - - - result_id is a valid resultid returned by - ifx_query or - ifx_prepare (select type queries only!). - - - position 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. - - - ifx_fetch_row 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. - - - Subsequent calls to ifx_fetch_row would - return the next row in the result set, or &false; if there are no - more rows. - - - - Informix fetch rows - + + + + ifx_fetch_row + Get row as enumerated array + + + Description + + arrayifx_fetch_row + resourceresult_id + mixedposition + + + Returns an associative array that corresponds to the fetched row, + or &false; if there are no more rows. + + + Blob columns are returned as integer blob id values for use in + ifx_get_blob unless you have used + ifx_textasvarchar(1) or ifx_byteasvarchar(1), in which case blobs + are returned as string values. Returns &false; on error + + + result_id is a valid resultid returned by + ifx_query or + ifx_prepare (select type queries only!). + + + position 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. + + + ifx_fetch_row 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. + + + Subsequent calls to ifx_fetch_row would + return the next row in the result set, or &false; if there are no + more rows. + + + + Informix fetch rows + ]]> - - - - - + + + + + - - - - ifx_fieldproperties - List of SQL fieldproperties - - - Description - - arrayifx_fieldproperties - resourceresult_id - - - Returns an associative array with fieldnames as key and the SQL - fieldproperties as data for a query with - result_id. Returns &false; on error. - - - 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". - - - - Informix SQL fieldproperties - + + + + ifx_fieldproperties + List of SQL fieldproperties + + + Description + + arrayifx_fieldproperties + resourceresult_id + + + Returns an associative array with fieldnames as key and the SQL + fieldproperties as data for a query with + result_id. Returns &false; on error. + + + 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". + + + + Informix SQL fieldproperties + $val) { } ?> ]]> - - - - - + + + + + - - - - ifx_fieldtypes - List of Informix SQL fields - - - Description - - arrayifx_fieldtypes - resourceresult_id - - - Returns an associative array with fieldnames as key and the SQL - fieldtypes as data for query with - result_id. Returns &false; on error. - - - - Fieldnames and SQL fieldtypes - + + + + ifx_fieldtypes + List of Informix SQL fields + + + Description + + arrayifx_fieldtypes + resourceresult_id + + + Returns an associative array with fieldnames as key and the SQL + fieldtypes as data for query with + result_id. Returns &false; on error. + + + + Fieldnames and SQL fieldtypes + $val) { } ?> ]]> - - - - - + + + + + - - - - ifx_free_blob - Deletes the blob object - - - Description - - boolifx_free_blob - intbid - - - Deletes the blobobject for the given blob object-id - bid. - - - &return.success; - - - + + + + ifx_free_blob + Deletes the blob object + + + Description + + boolifx_free_blob + intbid + + + Deletes the blobobject for the given blob object-id + bid. + + + &return.success; + + + - - - - ifx_free_char - Deletes the char object - - - Description - - boolifx_free_char - intbid - - - Deletes the charobject for the given char object-id - bid. - - - &return.success; - - - + + + + ifx_free_char + Deletes the char object + + + Description + + boolifx_free_char + intbid + + + Deletes the charobject for the given char object-id + bid. + + + &return.success; + + + - - - - ifx_free_result - Releases resources for the query - - - Description - - boolifx_free_result - resourceresult_id - - - Releases resources for the query associated with - result_id. - - - &return.success; - - - + + + + ifx_free_result + Releases resources for the query + + + Description + + boolifx_free_result + resourceresult_id + + + Releases resources for the query associated with + result_id. + + + &return.success; + + + - - - - ifx_get_blob - Return the content of a blob object - - - Description - - stringifx_get_blob - intbid - - - Returns the content of the blob object for the given blob - object-id bid. - - - + + + + ifx_get_blob + Return the content of a blob object + + + Description + + stringifx_get_blob + intbid + + + Returns the content of the blob object for the given blob + object-id bid. + + + - - - - ifx_get_char - Return the content of the char object - - - Description - - stringifx_get_char - intbid - - - Returns the content of the char object for the given char - object-id bid. - - - + + + + ifx_get_char + Return the content of the char object + + + Description + + stringifx_get_char + intbid + + + Returns the content of the char object for the given char + object-id bid. + + + - - - - ifx_getsqlca - - Get the contents of sqlca.sqlerrd[0..5] after a query - - - - Description - - arrayifx_getsqlca - resourceresult_id - - - result_id is a valid result id returned by - ifx_query or - ifx_prepare. - - - Returns a pseudo-row (associative array) with sqlca.sqlerrd[0] - ... sqlca.sqlerrd[5] after the query associated with - result_id. - - - 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. - - - - Retrieve Informix sqlca.sqlerrd[x] values - + + + + ifx_getsqlca + Get the contents of sqlca.sqlerrd[0..5] after a query + + + Description + + arrayifx_getsqlca + resourceresult_id + + + result_id is a valid result id returned by + ifx_query or + ifx_prepare. + + + Returns a pseudo-row (associative array) with sqlca.sqlerrd[0] + ... sqlca.sqlerrd[5] after the query associated with + result_id. + + + 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. + + + + Retrieve Informix sqlca.sqlerrd[x] values + \n"; +echo "The serial value of the inserted row is : $serial_value
\n"; ?> ]]> - - - - - + + + + + - - - - ifx_htmltbl_result - - Formats all rows of a query into a HTML table - - - - Description - - intifx_htmltbl_result - resourceresult_id - stringhtml_table_options - - - Returns the number of rows fetched or &false; on error. - - - Formats all rows of the result_id query - into a HTML table. The optional second argument is a string of - <table> tag options - - - - Informix results as HTML table - + + + + ifx_htmltbl_result + Formats all rows of a query into a HTML table + + + Description + + intifx_htmltbl_result + resourceresult_id + stringhtml_table_options + + + Returns the number of rows fetched or &false; on error. + + + Formats all rows of the result_id query + into a HTML table. The optional second argument is a string of + <table> tag options + + + + Informix results as HTML table + ]]> - - - - - + + + + + - - - - ifx_nullformat - - Sets the default return value on a fetch row - - - - Description - - boolifx_nullformat - intmode - - - Sets the default return value of a NULL-value on a fetch row. - Mode "0" returns "", and mode "1" returns "&null;". - - - &return.success; - - - + + + + ifx_nullformat + Sets the default return value on a fetch row + + + Description + + boolifx_nullformat + intmode + + + Sets the default return value of a NULL-value on a fetch row. + Mode "0" returns "", and mode "1" returns "&null;". + + + &return.success; + + + - - - - ifx_num_fields - Returns the number of columns in the query - - - Description - - intifx_num_fields - resourceresult_id - - - Returns the number of columns in query for - result_id or &false; on error - - - After preparing or executing a query, this call gives you the - number of columns in the query. - - - + + + + ifx_num_fields + Returns the number of columns in the query + + + Description + + intifx_num_fields + resourceresult_id + + + Returns the number of columns in query for + result_id or &false; on error + + + After preparing or executing a query, this call gives you the + number of columns in the query. + + + - - - - ifx_num_rows - Count the rows already fetched from a query - - - Description - - intifx_num_rows - resourceresult_id - - - Gives the number of rows fetched so far for a query with - result_id after a - ifx_query or ifx_do - query. - - - + + + + ifx_num_rows + Count the rows already fetched from a query + + + Description + + intifx_num_rows + resourceresult_id + + + Gives the number of rows fetched so far for a query with + result_id after a + ifx_query or ifx_do + query. + + + - - - - ifx_pconnect - Open persistent Informix connection - - - Description - - resourceifx_pconnect - stringdatabase - stringuserid - stringpassword - - - Returns: valid Informix persistent link identifier on success, - or &false; on error. - - - ifx_pconnect acts very much like - ifx_connect with two major differences. - - - 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. - - - 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 (ifx_close will not - close links established by ifx_pconnect). - - - This type of links is therefore called 'persistent'. - - - See also: ifx_connect. - - - + + + + ifx_pconnect + Open persistent Informix connection + + + Description + + resourceifx_pconnect + stringdatabase + stringuserid + stringpassword + + + Returns: valid Informix persistent link identifier on success, + or &false; on error. + + + ifx_pconnect acts very much like + ifx_connect with two major differences. + + + 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. + + + 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 (ifx_close will not + close links established by ifx_pconnect). + + + This type of links is therefore called 'persistent'. + + + See also: ifx_connect. + + + - - - - ifx_prepare - Prepare an SQL-statement for execution - - - Description - - resourceifx_prepare - stringquery - resourceconn_id - intcursor_def - mixedblobidarray - - - Returns valid result_id for use by - ifx_do. Sets - affected_rows for retrieval by the - ifx_affected_rows function. - - - Prepares query on connection - conn_id. For "select-type" queries a - cursor is declared and opened. The optional - cursor_type 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 either query type the estimated number of affected rows is - saved for retrieval by ifx_affected_rows. - - - If you have BLOB (BYTE or TEXT) columns in the query, you can add - a blobidarray 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 "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 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). - - - See also: ifx_do. - - - + + + + ifx_prepare + Prepare an SQL-statement for execution + + + Description + + resourceifx_prepare + stringquery + resourceconn_id + intcursor_def + mixedblobidarray + + + Returns valid result_id for use by + ifx_do. Sets + affected_rows for retrieval by the + ifx_affected_rows function. + + + Prepares query on connection + conn_id. For "select-type" queries a + cursor is declared and opened. The optional + cursor_type 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 either query type the estimated number of affected rows is + saved for retrieval by ifx_affected_rows. + + + If you have BLOB (BYTE or TEXT) columns in the query, you can add + a blobidarray 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 "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 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). + + + See also: ifx_do. + + + - - - - ifx_query - Send Informix query - - - Description - - resourceifx_query - stringquery - resourcelink_identifier - intcursor_type - mixed - blobidarray - - - - Returns valid Informix result identifier on success, or - &false; on error. - - - A "result_id" resource used by other functions to retrieve the - query results. Sets "affected_rows" for retrieval by the - ifx_affected_rows function. - - - ifx_query sends a query to the currently - active database on the server that's associated with the - specified link identifier. - - - Executes query on connection - conn_id. For "select-type" queries a - cursor is declared and opened. The optional - cursor_type 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. - - - For either query type the number of (estimated or real) affected - rows is saved for retrieval by - ifx_affected_rows. - - - If you have BLOB (BYTE or TEXT) columns in an update query, you - can add a blobidarray 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 "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 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). - - - - - Show all rows of the "orders" table as a HTML table - - + + + + ifx_query + Send Informix query + + + Description + + resourceifx_query + stringquery + resourcelink_identifier + intcursor_type + mixedblobidarray + + + Returns valid Informix result identifier on success, or + &false; on error. + + + A "result_id" resource used by other functions to retrieve the + query results. Sets "affected_rows" for retrieval by the + ifx_affected_rows function. + + + ifx_query sends a query to the currently + active database on the server that's associated with the + specified link identifier. + + + Executes query on connection + conn_id. For "select-type" queries a + cursor is declared and opened. The optional + cursor_type 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. + + + For either query type the number of (estimated or real) affected + rows is saved for retrieval by + ifx_affected_rows. + + + If you have BLOB (BYTE or TEXT) columns in an update query, you + can add a blobidarray 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 "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 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). + + + + + Show all rows of the "orders" table as a HTML table + + ]]> - - - - Insert some values into the "catalog" table - - + + + Insert some values into the "catalog" table + + ]]> - - - - - See also ifx_connect. - - - + + + + + See also ifx_connect. + + + - - - - ifx_textasvarchar - Set the default text mode - - - Description - - boolifx_textasvarchar - intmode - - - 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. - - - &return.success; - - - + + + + ifx_textasvarchar + Set the default text mode + + + Description + + boolifx_textasvarchar + intmode + + + 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. + + + &return.success; + + + - - - - ifx_update_blob - Updates the content of the blob object - - - Description - - boolifx_update_blob - intbid - stringcontent - - - Updates the content of the blob object for the given blob object - bid. content is a - string with new data. - - - &return.success; - - - + + + + ifx_update_blob + Updates the content of the blob object + + + Description + + boolifx_update_blob + intbid + stringcontent + + + Updates the content of the blob object for the given blob object + bid. content is a + string with new data. + + + &return.success; + + + - - - - ifx_update_char - Updates the content of the char object - - - Description - - boolifx_update_char - intbid - stringcontent - - - Updates the content of the char object for the given char object - bid. content is a - string with new data. - - - &return.success; - - - + + + + ifx_update_char + Updates the content of the char object + + + Description + + boolifx_update_char + intbid + stringcontent + + + Updates the content of the char object for the given char object + bid. content is a + string with new data. + + + &return.success; + + + - - - - ifxus_close_slob - Deletes the slob object - - - Description - - boolifxus_close_slob - intbid - - - Deletes the slob object on the given slob object-id - bid. - - - &return.success; - - - + + + + ifxus_close_slob + Deletes the slob object + + + Description + + boolifxus_close_slob + intbid + + + Deletes the slob object on the given slob object-id + bid. + + + &return.success; + + + - - - - ifxus_create_slob - Creates an slob object and opens it - - - Description - - intifxus_create_slob - intmode - - - 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. - - - + + + + ifxus_create_slob + Creates an slob object and opens it + + + Description + + intifxus_create_slob + intmode + + + 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. + + + - - - - ifxus_free_slob - Deletes the slob object - - - Description - - boolifxus_free_slob - intbid - - - Deletes the slob object. bid is the Id of - the slob object. - - - &return.success; - - - + + + + ifxus_free_slob + Deletes the slob object + + + Description + + boolifxus_free_slob + intbid + + + Deletes the slob object. bid is the Id of + the slob object. + + + &return.success; + + + - - - - ifxus_open_slob - Opens an slob object - - - Description - - intifxus_open_slob - intbid - intmode - - - Opens an slob object. bid 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. - - - + + + + ifxus_open_slob + Opens an slob object + + + Description + + intifxus_open_slob + intbid + intmode + + + Opens an slob object. bid 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. + + + - - - - ifxus_read_slob - Reads nbytes of the slob object - - - Description - - stringifxus_read_slob - intbid - intnbytes - - - Reads nbytes of the slob object. bid is an - existing slob id and nbytes is the number - of bytes to read. Return &false; on error otherwise the string. - - - + + + + ifxus_read_slob + Reads nbytes of the slob object + + + Description + + stringifxus_read_slob + intbid + intnbytes + + + Reads nbytes of the slob object. bid is an + existing slob id and nbytes is the number + of bytes to read. Return &false; on error otherwise the string. + + + - - - - ifxus_seek_slob - Sets the current file or seek position - - - Description - - intifxus_seek_slob - intbid - intmode - intoffset - - - Sets the current file or seek position of an open slob object. - bid should be an existing slob id. Modes: - 0 = LO_SEEK_SET, 1 = LO_SEEK_CUR, 2 = LO_SEEK_END and - offset is an byte offset. Return &false; on - error otherwise the seek position. - - - + + + + ifxus_seek_slob + Sets the current file or seek position + + + Description + + intifxus_seek_slob + intbid + intmode + intoffset + + + Sets the current file or seek position of an open slob object. + bid should be an existing slob id. Modes: + 0 = LO_SEEK_SET, 1 = LO_SEEK_CUR, 2 = LO_SEEK_END and + offset is an byte offset. Return &false; on + error otherwise the seek position. + + + - - - - ifxus_tell_slob - Returns the current file or seek position - - - Description - - intifxus_tell_slob - intbid - - - Returns the current file or seek position of an open slob object - bid should be an existing slob id. Return - &false; on error otherwise the seek position. - - - + + + + ifxus_tell_slob + Returns the current file or seek position + + + Description + + intifxus_tell_slob + intbid + + + Returns the current file or seek position of an open slob object + bid should be an existing slob id. Return + &false; on error otherwise the seek position. + + + - - - - ifxus_write_slob - Writes a string into the slob object - - - Description - - intifxus_write_slob - intbid - stringcontent - - - Writes a string into the slob object. bid - is an existing slob id and content the - content to write. Return &false; on error otherwise bytes written. - - - + + + + ifxus_write_slob + Writes a string into the slob object + + + Description + + intifxus_write_slob + intbid + stringcontent + + + Writes a string into the slob object. bid + is an existing slob id and content the + content to write. Return &false; on error otherwise bytes written. + + +