From f6863a9ad9f9832ee38036c862813454be82a170 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Sat, 16 Jun 2007 19:11:13 +0000 Subject: [PATCH] ref.maxdb: Finalize new style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@237843 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../maxdb/functions/maxdb-affected-rows.xml | 35 ++++++++----- .../maxdb/functions/maxdb-autocommit.xml | 35 ++++++++----- .../maxdb/functions/maxdb-bind-param.xml | 3 +- .../maxdb/functions/maxdb-bind-result.xml | 3 +- .../maxdb/functions/maxdb-change-user.xml | 35 ++++++++----- .../functions/maxdb-character-set-name.xml | 35 ++++++++----- .../maxdb/functions/maxdb-client-encoding.xml | 3 +- .../maxdb/functions/maxdb-close-long-data.xml | 3 +- reference/maxdb/functions/maxdb-close.xml | 26 ++++++---- reference/maxdb/functions/maxdb-commit.xml | 35 ++++++++----- .../maxdb/functions/maxdb-connect-errno.xml | 51 +++++++++++-------- .../maxdb/functions/maxdb-connect-error.xml | 41 ++++++++------- reference/maxdb/functions/maxdb-connect.xml | 18 ++++--- reference/maxdb/functions/maxdb-data-seek.xml | 37 ++++++++------ reference/maxdb/functions/maxdb-debug.xml | 18 ++++--- .../maxdb-disable-reads-from-master.xml | 8 +-- .../functions/maxdb-disable-rpl-parse.xml | 8 +-- .../maxdb/functions/maxdb-dump-debug-info.xml | 8 +-- .../functions/maxdb-embedded-connect.xml | 8 +-- .../maxdb-enable-reads-from-master.xml | 8 +-- .../functions/maxdb-enable-rpl-parse.xml | 8 +-- reference/maxdb/functions/maxdb-errno.xml | 39 ++++++++------ reference/maxdb/functions/maxdb-error.xml | 39 ++++++++------ .../maxdb/functions/maxdb-escape-string.xml | 3 +- reference/maxdb/functions/maxdb-execute.xml | 3 +- .../maxdb/functions/maxdb-fetch-array.xml | 37 ++++++++------ .../maxdb/functions/maxdb-fetch-assoc.xml | 37 ++++++++------ .../functions/maxdb-fetch-field-direct.xml | 37 ++++++++------ .../maxdb/functions/maxdb-fetch-field.xml | 39 ++++++++------ .../maxdb/functions/maxdb-fetch-fields.xml | 37 ++++++++------ .../maxdb/functions/maxdb-fetch-lengths.xml | 18 ++++--- .../maxdb/functions/maxdb-fetch-object.xml | 37 ++++++++------ reference/maxdb/functions/maxdb-fetch-row.xml | 37 ++++++++------ reference/maxdb/functions/maxdb-fetch.xml | 3 +- .../maxdb/functions/maxdb-field-count.xml | 22 +++++--- .../maxdb/functions/maxdb-field-seek.xml | 33 +++++++----- .../maxdb/functions/maxdb-field-tell.xml | 33 +++++++----- .../maxdb/functions/maxdb-free-result.xml | 23 +++++---- .../maxdb/functions/maxdb-get-client-info.xml | 35 ++++++++----- .../functions/maxdb-get-client-version.xml | 37 ++++++++------ .../maxdb/functions/maxdb-get-host-info.xml | 31 ++++++----- .../maxdb/functions/maxdb-get-metadata.xml | 3 +- .../maxdb/functions/maxdb-get-proto-info.xml | 31 ++++++----- .../maxdb/functions/maxdb-get-server-info.xml | 35 ++++++++----- .../functions/maxdb-get-server-version.xml | 35 ++++++++----- reference/maxdb/functions/maxdb-info.xml | 35 ++++++++----- reference/maxdb/functions/maxdb-init.xml | 24 +++++---- reference/maxdb/functions/maxdb-insert-id.xml | 16 +++--- reference/maxdb/functions/maxdb-kill.xml | 31 ++++++----- .../maxdb/functions/maxdb-master-query.xml | 8 +-- .../maxdb/functions/maxdb-more-results.xml | 39 ++++++++------ .../maxdb/functions/maxdb-multi-query.xml | 39 ++++++++------ .../maxdb/functions/maxdb-next-result.xml | 34 ++++++++----- .../maxdb/functions/maxdb-num-fields.xml | 31 ++++++----- reference/maxdb/functions/maxdb-num-rows.xml | 37 ++++++++------ reference/maxdb/functions/maxdb-options.xml | 31 +++++++---- .../maxdb/functions/maxdb-param-count.xml | 3 +- reference/maxdb/functions/maxdb-ping.xml | 18 ++++--- reference/maxdb/functions/maxdb-prepare.xml | 39 ++++++++------ reference/maxdb/functions/maxdb-query.xml | 37 ++++++++------ .../maxdb/functions/maxdb-real-connect.xml | 39 ++++++++------ .../functions/maxdb-real-escape-string.xml | 33 +++++++----- .../maxdb/functions/maxdb-real-query.xml | 26 ++++++---- reference/maxdb/functions/maxdb-report.xml | 13 +++-- reference/maxdb/functions/maxdb-rollback.xml | 35 ++++++++----- .../functions/maxdb-rpl-parse-enabled.xml | 8 +-- reference/maxdb/functions/maxdb-rpl-probe.xml | 8 +-- .../maxdb/functions/maxdb-rpl-query-type.xml | 8 +-- reference/maxdb/functions/maxdb-select-db.xml | 35 ++++++++----- .../maxdb/functions/maxdb-send-long-data.xml | 3 +- .../maxdb/functions/maxdb-send-query.xml | 8 +-- .../maxdb/functions/maxdb-server-end.xml | 8 +-- .../maxdb/functions/maxdb-server-init.xml | 8 +-- reference/maxdb/functions/maxdb-set-opt.xml | 3 +- reference/maxdb/functions/maxdb-sqlstate.xml | 35 ++++++++----- reference/maxdb/functions/maxdb-ssl-set.xml | 8 +-- reference/maxdb/functions/maxdb-stat.xml | 33 +++++++----- .../functions/maxdb-stmt-affected-rows.xml | 35 ++++++++----- .../maxdb/functions/maxdb-stmt-bind-param.xml | 45 +++++++++------- .../functions/maxdb-stmt-bind-result.xml | 47 +++++++++-------- .../functions/maxdb-stmt-close-long-data.xml | 20 +++++--- .../maxdb/functions/maxdb-stmt-close.xml | 22 +++++--- .../maxdb/functions/maxdb-stmt-data-seek.xml | 33 +++++++----- .../maxdb/functions/maxdb-stmt-errno.xml | 39 ++++++++++---- .../maxdb/functions/maxdb-stmt-error.xml | 35 ++++++++----- .../maxdb/functions/maxdb-stmt-execute.xml | 35 ++++++++----- .../maxdb/functions/maxdb-stmt-fetch.xml | 39 ++++++++------ .../functions/maxdb-stmt-free-result.xml | 17 ++++--- reference/maxdb/functions/maxdb-stmt-init.xml | 18 ++++--- .../maxdb/functions/maxdb-stmt-num-rows.xml | 37 ++++++++------ .../functions/maxdb-stmt-param-count.xml | 31 ++++++----- .../maxdb/functions/maxdb-stmt-prepare.xml | 41 ++++++++------- .../maxdb/functions/maxdb-stmt-reset.xml | 8 +-- .../functions/maxdb-stmt-result-metadata.xml | 33 +++++++----- .../functions/maxdb-stmt-send-long-data.xml | 20 +++++--- .../maxdb/functions/maxdb-stmt-sqlstate.xml | 35 ++++++++----- .../functions/maxdb-stmt-store-result.xml | 37 ++++++++------ .../maxdb/functions/maxdb-store-result.xml | 35 ++++++++----- reference/maxdb/functions/maxdb-thread-id.xml | 33 +++++++----- .../maxdb/functions/maxdb-thread-safe.xml | 13 +++-- .../maxdb/functions/maxdb-use-result.xml | 35 ++++++++----- .../maxdb/functions/maxdb-warning-count.xml | 37 ++++++++------ 102 files changed, 1588 insertions(+), 1035 deletions(-) diff --git a/reference/maxdb/functions/maxdb-affected-rows.xml b/reference/maxdb/functions/maxdb-affected-rows.xml index eecdb50365..d28019f7ae 100644 --- a/reference/maxdb/functions/maxdb-affected-rows.xml +++ b/reference/maxdb/functions/maxdb-affected-rows.xml @@ -1,13 +1,14 @@ - + maxdb_affected_rows maxdb->affected_rows Gets the number of affected rows in a previous MaxDB operation - - Description + + + &reftitle.description; Procedural style: intmaxdb_affected_rows @@ -35,8 +36,9 @@ maxdb_num_rows function instead. - - Return Values + + + &reftitle.returnvalues; An integer greater than zero indicates the number of rows affected or retrieved. Zero indicates that no records where updated for an UPDATE statement, no rows matched @@ -44,15 +46,9 @@ -1 indicates that the number of rows affected can not be determined. - - See also - - maxdb_num_rows, - maxdb_info. - - - - Example + + + &reftitle.examples; Object oriented style @@ -156,6 +152,17 @@ Affected rows (SELECT): 15 ]]> + + + &reftitle.seealso; + + + maxdb_num_rows + maxdb_info + + + + + maxdb_autocommit maxdb->auto_commit Turns on or off auto-commiting database modifications - - Description + + + &reftitle.description; Procedural style: boolmaxdb_autocommit @@ -29,21 +30,16 @@ resource. - - Return values + + + &reftitle.returnvalues; &return.success; - - See also - - maxdb_commit, - maxdb_rollback. - - - - Example + + + &reftitle.examples; Object oriented style @@ -90,6 +86,17 @@ maxdb_close($link); The above examples would produce no output. + + + &reftitle.seealso; + + + maxdb_commit + maxdb_rollback + + + + + maxdb_bind_param @@ -14,6 +14,7 @@ &info.function.alias.deprecated; + + maxdb_bind_result @@ -14,6 +14,7 @@ &info.function.alias.deprecated; + + maxdb_change_user maxdb->change_user Changes the user of the specified database connection - - Description + + + &reftitle.description; Procedural style: boolmaxdb_change_user @@ -47,21 +48,16 @@ - - Return Values + + + &reftitle.returnvalues; &return.success; - - See also: - - maxdb_connect - maxdb_select_db - - - - Example + + + &reftitle.examples; Object oriented style @@ -138,6 +134,17 @@ Database running ]]> + + + &reftitle.seealso; + + + maxdb_connect + maxdb_select_db + + + + + maxdb_character_set_name maxdb->character_set_name Returns the default character set for the database connection - - Description + + + &reftitle.description; Procedural style: stringmaxdb_character_set_name @@ -27,19 +28,14 @@ link parameter. - - Return values + + + &reftitle.returnvalues; The default character set for the current connection, either ascii or unicode. - - See also - - maxdb_client_encoding. - maxdb_real_escape_string. - - - - Example + + + &reftitle.examples; Object oriented style @@ -95,6 +91,17 @@ Current character set is ascii ]]> + + + &reftitle.seealso; + + + maxdb_client_encoding + maxdb_real_escape_string + + + + + maxdb_client_encoding @@ -14,6 +14,7 @@ &info.function.alias.deprecated; + + maxdb_close_long_data @@ -15,6 +15,7 @@ &info.function.alias.deprecated; + + maxdb_close maxdb->close Closes a previously opened database connection - - Description + + + &reftitle.description; Procedural style: boolmaxdb_close @@ -27,20 +28,25 @@ connection specified by the link parameter. - - Return values + + + &reftitle.returnvalues; &return.success; - - See also + + + &reftitle.seealso; - maxdb_connect, - maxdb_init, - maxdb_real_connect. + + maxdb_connect + maxdb_init + maxdb_real_connect + + + maxdb_commit maxdb->commit Commits the current transaction - - Description + + + &reftitle.description; Procedural style: boolmaxdb_commit @@ -27,21 +28,16 @@ link parameter. - - Return values + + + &reftitle.returnvalues; &return.success; - - See also - - maxdb_autocommit, - maxdb_rollback. - - - - Example + + + &reftitle.examples; Object oriented style @@ -116,6 +112,17 @@ maxdb_close($link); The above examples produces no output. + + + &reftitle.seealso; + + + maxdb_autocommit + maxdb_rollback + + + + + maxdb_connect_errno Returns the error code from last connect call - - Description + + + &reftitle.description; intmaxdb_connect_errno @@ -17,25 +18,17 @@ If no errors have occured, this function will return zero. - - Return values + + + &reftitle.returnvalues; An error code value for the last call to maxdb_connect, if it failed. zero means no error occurred. - - See also - - maxdb_connect, - maxdb_connect_error, - maxdb_errno, - maxdb_error, - maxdb_sqlstate - - - - Example + + + &reftitle.examples; maxdb_connect_errno sample @@ -52,16 +45,30 @@ if (!$link) { - - The above example would produce the following output: - - + + The above example would produce the following output: + + Can't connect to localhost. Errorcode: -4008 ]]> - + + + + &reftitle.seealso; + + + maxdb_connect + maxdb_connect_error + maxdb_errno + maxdb_error + maxdb_sqlstate + + + + + maxdb_connect_error Returns a string description of the last connect error - - Description + + + &reftitle.description; stringmaxdb_connect_error @@ -20,24 +21,16 @@ If no error has occured, this function will return an empty string. - - Return values + + + &reftitle.returnvalues; A string that describes the error. An empty string if no error occurred. - - See also - - maxdb_connect, - maxdb_connect_errno, - maxdb_errno, - maxdb_error, - maxdb_sqlstate - - - - Example + + + &reftitle.examples; maxdb_connect_error sample @@ -65,6 +58,20 @@ Can't connect to localhost. Error: POS(1) Unknown user name/password combination ]]> + + + &reftitle.seealso; + + + maxdb_connect + maxdb_connect_errno + maxdb_errno + maxdb_error + maxdb_sqlstate + + + + + maxdb_connect maxdb() Open a new connection to the MaxDB server - - Description + + + &reftitle.description; Procedural style resourcemaxdb_connect @@ -54,15 +55,17 @@ ignored for the MaxDB server. - - Return values + + + &reftitle.returnvalues; Returns a resource which represents the connection to a MaxDB Server or &false; if the connection failed. - - Example + + + &reftitle.examples; Object oriented style @@ -114,6 +117,7 @@ Host information: localhost ]]> + + maxdb_data_seek result->data_seek Adjusts the result pointer to an arbitary row in the result - - Description + + + &reftitle.description; Procedural style: boolmaxdb_data_seek @@ -30,22 +31,16 @@ zero and the total number of rows minus one (0..maxdb_num_rows - 1). - - Return values + + + &reftitle.returnvalues; &return.success; - - See also - - maxdb_store_result, - maxdb_fetch_row, - maxdb_num_rows. - - - - Example + + + &reftitle.examples; Object oriented style @@ -125,6 +120,18 @@ City: Irvine State: CA ]]> + + + &reftitle.seealso; + + + maxdb_store_result + maxdb_fetch_row + maxdb_num_rows + + + + + maxdb_debug Performs debugging operations - - Description + + + &reftitle.description; voidmaxdb_debug stringdebug @@ -27,14 +28,16 @@ at least 8192 bytes are required. - - Return values + + + &reftitle.returnvalues; maxdb_debug doesn't return any value. - - Example + + + &reftitle.examples; Procedural style @@ -61,6 +64,7 @@ maxdb_close($link); The above example produces no output. + + maxdb_disable_reads_from_master maxdb->disable_reads_from_master Disable reads from master - - Description + + + &reftitle.description; Procedural style: boolmaxdb_disable_reads_from_master @@ -25,6 +26,7 @@ &warn.undocumented.func; + + maxdb_disable_rpl_parse Disable RPL parse - - Description + + + &reftitle.description; boolmaxdb_disable_rpl_parse resourcelink @@ -15,6 +16,7 @@ &warn.undocumented.func; + + maxdb_dump_debug_info Dump debugging information into the log - - Description + + + &reftitle.description; boolmaxdb_dump_debug_info resourcelink @@ -15,6 +16,7 @@ &warn.undocumented.func; + + maxdb_embedded_connect Open a connection to an embedded MaxDB server - - Description + + + &reftitle.description; resourcemaxdb_embedded_connect stringdbname @@ -15,6 +16,7 @@ &warn.undocumented.func; + + maxdb_enable_reads_from_master Enable reads from master - - Description + + + &reftitle.description; boolmaxdb_enable_reads_from_master resourcelink @@ -15,6 +16,7 @@ &warn.undocumented.func; + + maxdb_enable_rpl_parse Enable RPL parse - - Description + + + &reftitle.description; boolmaxdb_enable_rpl_parse resourcelink @@ -15,6 +16,7 @@ &warn.undocumented.func; + + maxdb_errno maxdb->errno Returns the error code for the most recent function call - - Description + + + &reftitle.description; Procedural style: intmaxdb_errno @@ -25,23 +26,16 @@ have occured, this function will return zero. - - Return values + + + &reftitle.returnvalues; An error code value for the last call, if it failed. zero means no error occurred. - - See also - - maxdb_connect_errno, - maxdb_connect_error, - maxdb_error, - maxdb_sqlstate - - - - Example + + + &reftitle.examples; Object oriented style @@ -98,6 +92,19 @@ Errorcode: -4005 ]]> + + + &reftitle.seealso; + + + maxdb_connect_errno + maxdb_connect_error + maxdb_error + maxdb_sqlstate + + + + + maxdb_error Returns a string description of the last error - - Description + + + &reftitle.description; Procedural style: stringmaxdb_error @@ -26,23 +27,16 @@ this function will return an empty string. - - Return values + + + &reftitle.returnvalues; A string that describes the error. An empty string if no error occurred. - - See also - - maxdb_connect_errno, - maxdb_connect_error, - maxdb_errno, - maxdb_sqlstate - - - - Example + + + &reftitle.examples; Object oriented style @@ -99,6 +93,19 @@ Errormessgae: POS(8) Unknown column name:XXX ]]> + + + &reftitle.seealso; + + + maxdb_connect_errno + maxdb_connect_error + maxdb_errno + maxdb_sqlstate + + + + + maxdb_escape_string @@ -13,6 +13,7 @@ maxdb_real_escape_string. + + maxdb_execute @@ -14,6 +14,7 @@ &info.function.alias.deprecated; + + maxdb_fetch_array result->fetch_array Fetch a result row as an associative, a numeric array, or both - - Description + + + &reftitle.description; Procedural style: mixedmaxdb_fetch_array @@ -63,22 +64,16 @@ of MAXDB_ASSOC except the array index of a column is the fieldname in lower case. - - Return values + + + &reftitle.returnvalues; Returns an array that corresponds to the fetched row or &null; if there are no more rows in resultset. - - See also - - maxdb_fetch_assoc, - maxdb_fetch_row, - maxdb_fetch_resource. - - - - Example + + + &reftitle.examples; Object oriented style @@ -164,6 +159,18 @@ Long Island (NY) ]]> + + + &reftitle.seealso; + + + maxdb_fetch_assoc + maxdb_fetch_row + maxdb_fetch_resource + + + + + maxdb_fetch_assoc maxdb->fetch_assoc Fetch a result row as an associative array - - Description + + + &reftitle.description; Procedural style: arraymaxdb_fetch_assoc @@ -42,22 +43,16 @@ &database.field-case; &database.fetch-null; - - Return values + + + &reftitle.returnvalues; Returns an array that corresponds to the fetched row or &null; if there are no more rows in resultset. - - See also - - maxdb_fetch_array, - maxdb_fetch_row, - maxdb_fetch_resource. - - - - Example + + + &reftitle.examples; Object oriented style @@ -155,6 +150,18 @@ Portland (OR) ]]> + + + &reftitle.seealso; + + + maxdb_fetch_array + maxdb_fetch_row + maxdb_fetch_resource + + + + + maxdb_fetch_field_direct result->fetch_field_direct Fetch meta-data for a single field - - Description + + + &reftitle.description; Procedural style: mixedmaxdb_fetch_field_direct @@ -29,8 +30,9 @@ range from 0 to number of fields - 1. - - Return values + + + &reftitle.returnvalues; Returns an resource which contains field definition informations or &false; if no field information for specified fieldnr is available. @@ -67,16 +69,9 @@ - - See also - - maxdb_num_fields - maxdb_fetch_field - maxdb_fetch_fields - - - - Example + + + &reftitle.examples; Object oriented style @@ -160,6 +155,18 @@ Type: 0 ]]> + + + &reftitle.seealso; + + + maxdb_num_fields + maxdb_fetch_field + maxdb_fetch_fields + + + + + maxdb_fetch_field result->fetch_field Returns the next field in the result set - - Description + + + &reftitle.description; Procedural style: mixedmaxdb_fetch_field @@ -29,8 +30,9 @@ are left. - - Return values + + + &reftitle.returnvalues; Returns an resource which contains field definition informations or &false; if no field information is available. @@ -67,17 +69,9 @@ - - See also - - maxdb_num_fields - maxdb_fetch_field_direct - maxdb_fetch_fields - maxdb_field_seek - - - - Example + + + &reftitle.examples; Object oriented style @@ -167,6 +161,19 @@ Type: 0 ]]> + + + &reftitle.seealso; + + + maxdb_num_fields + maxdb_fetch_field_direct + maxdb_fetch_fields + maxdb_field_seek + + + + + maxdb_fetch_fields result->fetch_fields Returns an array of resources representing the fields in a result set - - Description + + + &reftitle.description; Procedural Style: mixedmaxdb_fetch_fields @@ -28,8 +29,9 @@ each field, the columns are returned as an array of resources. - - Return values + + + &reftitle.returnvalues; Returns an array of resources which contains field definition informations or &false; if no field information is available. @@ -66,16 +68,9 @@ - - See also - - maxdb_num_fields - maxdb_fetch_field - maxdb_fetch_field_direct - - - - Example + + + &reftitle.examples; Object oriented style @@ -167,6 +162,18 @@ Type: 0 ]]> + + + &reftitle.seealso; + + + maxdb_num_fields + maxdb_fetch_field + maxdb_fetch_field_direct + + + + + maxdb_fetch_lengths result->lengths Returns the lengths of the columns of the current row in the result set - - Description + + + &reftitle.description; Procedural style: arraymaxdb_fetch_lengths @@ -25,8 +26,9 @@ representing the lengths of each column is returned or &false; on failure. - - Return values + + + &reftitle.returnvalues; An array of integers representing the size of each column (not including any terminating null characters). &false; if an error occurred. @@ -37,8 +39,9 @@ all rows in the result. - - Example + + + &reftitle.examples; Object oriented style @@ -117,6 +120,7 @@ Field 6 has Length 21 ]]> + + maxdb_fetch_object result->fetch_object Returns the current row of a result set as an object - - Description + + + &reftitle.description; Procedural style: objectmaxdb_fetch_object @@ -27,24 +28,18 @@ within the result set. If no more rows exist in the current result set, &null; is returned. - - Return values + + + &reftitle.returnvalues; Returns an object that corresponds to the fetched row or &null; if there are no more rows in resultset. &database.field-case; &database.fetch-null; - - See also - - maxdb_fetch_array, - maxdb_fetch_assoc, - maxdb_fetch_row. - - - - Example + + + &reftitle.examples; Object oriented style @@ -142,6 +137,18 @@ Portland (OR) ]]> + + + &reftitle.seealso; + + + maxdb_fetch_array + maxdb_fetch_assoc + maxdb_fetch_row + + + + + maxdb_fetch_row result->fetch_row Get a result row as an enumerated array - - Description + + + &reftitle.description; Procedural style: mixedmaxdb_fetch_row @@ -33,24 +34,18 @@ or &false; if there are no more rows. - - Return values + + + &reftitle.returnvalues; maxdb_fetch_row returns an array that corresponds to the fetched row or &null; if there are no more rows in result set. &database.fetch-null; - - See also - - maxdb_fetch_array, - maxdb_fetch_assoc, - maxdb_fetch_resource. - - - - Example + + + &reftitle.examples; Object oriented style @@ -148,6 +143,18 @@ Portland (OR) ]]> + + + &reftitle.seealso; + + + maxdb_fetch_array + maxdb_fetch_assoc + maxdb_fetch_resource + + + + + maxdb_fetch @@ -14,6 +14,7 @@ &info.function.alias.deprecated; + + maxdb_field_count maxdb->field_count Returns the number of columns for the most recent query - - Description + + + &reftitle.description; Procedural style: intmaxdb_field_count @@ -30,12 +31,16 @@ set or not without knowing the nature of the query. - - Return values - An integer representing the number of fields in a result set + + + &reftitle.returnvalues; + + An integer representing the number of fields in a result set. + - - Example + + + &reftitle.examples; Object oriented style @@ -108,6 +113,7 @@ maxdb_close($link); The above example produces no output. + + maxdb_field_seek result->field_seek Set result pointer to a specified field offset - - Description + + + &reftitle.description; Procedural style: boolmaxdb_field_seek @@ -30,20 +31,16 @@ To seek to the beginning of a row, pass an offset value of zero. - - Return values + + + &reftitle.returnvalues; maxdb_field_seek returns previuos value of field cursor. - - See also - - maxdb_fetch_field - - - - Example + + + &reftitle.examples; Object oriented style @@ -129,6 +126,16 @@ Type: 2 ]]> + + + &reftitle.seealso; + + + maxdb_fetch_field + + + + + maxdb_field_tell result->current_field Get current field offset of a result pointer - - Description + + + &reftitle.description; Procedural style: intmaxdb_field_tell @@ -27,21 +28,16 @@ be used as an argument to maxdb_field_seek. - + + &reftitle.returnvalues; Returns current offset of field cursor. - - &reftitle.seealso; - - maxdb_fetch_field, - maxdb_field_seek - - - - Example + + + &reftitle.examples; Object oriented style @@ -141,6 +137,17 @@ Type: 0 ]]> + + + &reftitle.seealso; + + + maxdb_fetch_field + maxdb_field_seek + + + + + maxdb_free_result result->free Frees the memory associated with a result - - Description + + + &reftitle.description; Procedural style: voidmaxdb_free_result @@ -36,19 +37,23 @@ - + + &reftitle.returnvalues; This function doesn't return any value. - + + &reftitle.seealso; - maxdb_query, - maxdb_stmt_store_result, - maxdb_store_result, - maxdb_use_result. + + maxdb_query + maxdb_stmt_store_result + maxdb_store_result + maxdb_use_result + diff --git a/reference/maxdb/functions/maxdb-get-client-info.xml b/reference/maxdb/functions/maxdb-get-client-info.xml index ad4c11add7..f8364ed332 100644 --- a/reference/maxdb/functions/maxdb-get-client-info.xml +++ b/reference/maxdb/functions/maxdb-get-client-info.xml @@ -1,12 +1,13 @@ - + maxdb_get_client_info Returns the MaxDB client version as a string - - Description + + + &reftitle.description; stringmaxdb_get_client_info @@ -17,22 +18,16 @@ MaxDB extension. - + + &reftitle.returnvalues; A string that represents the MaxDB client library version - - See also - - maxdb_get_client_version, - maxdb_get_server_info, - maxdb_get_server_version - - - - Example + + + &reftitle.examples; maxdb_get_client_info @@ -58,6 +53,18 @@ Client library version: libSQLDBC <...> ]]> + + + &reftitle.seealso; + + + maxdb_get_client_version + maxdb_get_server_info + maxdb_get_server_version + + + + + maxdb_get_client_version Get MaxDB client info - - Description + + + &reftitle.description; intmaxdb_get_client_version @@ -15,8 +16,9 @@ Returns client version number as an integer. - - Return values + + + &reftitle.returnvalues; A number that represents the MaxDB client library version in format: main_version*10000 + minor_version *100 + sub_version. @@ -27,16 +29,9 @@ to know if some capability exists. - - See also - - maxdb_get_client_info, - maxdb_get_server_info, - maxdb_get_server_version - - - - Example + + + &reftitle.examples; maxdb_get_client_version @@ -62,6 +57,18 @@ Client library version: 7.<...> ]]> + + + &reftitle.seealso; + + + maxdb_get_client_info + maxdb_get_server_info + maxdb_get_server_version + + + + + maxdb_get_host_info maxdb->get_host_info Returns a string representing the type of connection used - - Description + + + &reftitle.description; Procdural style: stringmaxdb_get_host_info @@ -24,20 +25,16 @@ parameter is using. - + + &reftitle.returnvalues; A character string representing the server hostname and the connection type. - - See also - - maxdb_get_proto_info - - - - Example + + + &reftitle.examples; Object oriented style @@ -91,6 +88,16 @@ Host info: localhost ]]> + + + &reftitle.seealso; + + + maxdb_get_proto_info + + + + + maxdb_get_metadata @@ -14,6 +14,7 @@ &info.function.alias.deprecated; + + maxdb_get_proto_info maxdb->protocol_version Returns the version of the MaxDB protocol used - - Description + + + &reftitle.description; Procedural style: intmaxdb_get_proto_info @@ -23,20 +24,16 @@ connection represented by the link parameter. - + + &reftitle.returnvalues; Returns an integer representing the protocol version (constant 10). - - See also - - maxdb_get_host_info - - - - Example + + + &reftitle.examples; Object oriented style @@ -90,6 +87,16 @@ Protocol version: 10 ]]> + + + &reftitle.seealso; + + + maxdb_get_host_info + + + + + maxdb_get_server_info maxdb->server_info Returns the version of the MaxDB server - - Description + + + &reftitle.description; Procedural style: stringmaxdb_get_server_info @@ -24,22 +25,16 @@ link parameter). - + + &reftitle.returnvalues; A character string representing the server version. - - See also - - maxdb_get_client_info, - maxdb_get_client_version, - maxdb_get_server_version - - - - Example + + + &reftitle.examples; Object oriented style @@ -93,6 +88,18 @@ Server version: Kernel 7<...> ]]> + + + &reftitle.seealso; + + + maxdb_get_client_info + maxdb_get_client_version + maxdb_get_server_version + + + + + maxdb_get_server_version Returns the version of the MaxDB server as an integer - - Description + + + &reftitle.description; Procedural style: intmaxdb_get_server_version @@ -28,22 +29,16 @@ (i.e. version 7.5.0 is 70500). - + + &reftitle.returnvalues; An integer representing the server version. - - See also - - maxdb_get_client_info, - maxdb_get_client_version, - maxdb_get_server_info - - - - Example + + + &reftitle.examples; Object oriented style @@ -97,6 +92,18 @@ Server version: 7<...> ]]> + + + &reftitle.seealso; + + + maxdb_get_client_info + maxdb_get_client_version + maxdb_get_server_info + + + + + maxdb_info maxdb->info Retrieves information about the most recently executed query - - Description + + + &reftitle.description; Procedural style: stringmaxdb_info @@ -65,22 +66,16 @@ - + + &reftitle.returnvalues; A character string representing additional information about the most recently executed query. - - &reftitle.seealso; - - maxdb_affected_rows, - maxdb_warning_count, - maxdb_num_rows - - - - Example + + + &reftitle.examples; Object oriented style @@ -140,6 +135,18 @@ Records: 25 Duplicates: 0 Warnings: 0 ]]> + + + &reftitle.seealso; + + + maxdb_affected_rows + maxdb_warning_count + maxdb_num_rows + + + + + maxdb_init Initializes MaxDB and returns an resource for use with maxdb_real_connect - - Description + + + &reftitle.description; resourcemaxdb_init @@ -22,21 +23,26 @@ - + + &reftitle.returnvalues; Returns an resource. - + + &reftitle.seealso; - maxdb_options, - maxdb_close, - maxdb_real_connect, - maxdb_connect + + maxdb_options + maxdb_close + maxdb_real_connect + maxdb_connect + + + maxdb_insert_id maxdb->insert_id Returns the auto generated id used in the last query - - Description + + + &reftitle.description; Procedural style: mixedmaxdb_insert_id @@ -26,7 +27,8 @@ return zero. - + + &reftitle.returnvalues; The value of the DEFAULT SERIAL field that was updated @@ -41,8 +43,9 @@ - - Example + + + &reftitle.examples; Object oriented style @@ -120,6 +123,7 @@ New Record has id 1. ]]> + + maxdb_kill maxdb->kill Disconnects from a MaxDB server - - Description + + + &reftitle.description; Procedural style: boolmaxdb_kill @@ -28,20 +29,16 @@ by the processid parameter. - + + &reftitle.returnvalues; &return.success; - - &reftitle.seealso; - - maxdb_thread_id - - - - Example + + + &reftitle.examples; Object oriented style @@ -113,6 +110,16 @@ Error: Session not connected ]]> + + + &reftitle.seealso; + + + maxdb_thread_id + + + + + maxdb_master_query Enforce execution of a query on the master in a master/slave setup - - Description + + + &reftitle.description; boolmaxdb_master_query resourcelink @@ -16,6 +17,7 @@ &warn.undocumented.func; + + maxdb_more_results maxdb->more_results Check if there any more query results from a multi query - - Description + + + &reftitle.description; boolmaxdb_more_results resourcelink @@ -17,25 +18,33 @@ are available from a previous call to maxdb_multi_query. - - Return values - Always &false;. - - - See also + + + &reftitle.returnvalues; - maxdb_multi_query, - maxdb_next_result, - maxdb_store_result, - maxdb_use_result + Always &false;. - - Example + + + &reftitle.examples; See maxdb_multi_query. + + + &reftitle.seealso; + + + maxdb_multi_query + maxdb_next_result + maxdb_store_result + maxdb_use_result + + + + + maxdb_multi_query maxdb->multi_query Performs a query on the database - - Description + + + &reftitle.description; Procedural style: boolmaxdb_multi_query @@ -28,23 +29,16 @@ maxdb_query. Multiple queries are not yet supported. - - Return values + + + &reftitle.returnvalues; &return.success; - - See also - - maxdb_use_result, - maxdb_store_result, - maxdb_next_result, - maxdb_more_results - - - - Example + + + &reftitle.examples; Object oriented style @@ -130,6 +124,19 @@ a ]]> + + + &reftitle.seealso; + + + maxdb_use_result + maxdb_store_result + maxdb_next_result + maxdb_more_results + + + + + maxdb_next_result maxdb->next_result Prepare next result from multi_query - - Description + + + &reftitle.description; boolmaxdb_next_result resourcelink @@ -17,19 +18,26 @@ returns always &false;. - - Return values - &false; - - - See also + + + &reftitle.returnvalues; - maxdb_multi_query, - maxdb_more_results, - maxdb_store_result, - maxdb_use_result + Returns &false;. + + + &reftitle.seealso; + + + maxdb_multi_query + maxdb_more_results + maxdb_store_result + maxdb_use_result + + + + + maxdb_num_fields result->field_count Get the number of fields in a result - - Description + + + &reftitle.description; Procedural style: intmaxdb_num_fields @@ -22,18 +23,14 @@ maxdb_num_fields returns the number of fields from specified result set. - + + &reftitle.returnvalues; The number of fields from a result set - - &reftitle.seealso; - - maxdb_fetch_field - - - - Example + + + &reftitle.examples; Object oriented style @@ -103,6 +100,16 @@ Result set has 3 fields. ]]> + + + &reftitle.seealso; + + + maxdb_fetch_field + + + + + maxdb_num_rows Gets the number of rows in a result - - Description + + + &reftitle.description; Procedural style: intmaxdb_num_rows @@ -28,7 +29,8 @@ have been retrieved. - + + &reftitle.returnvalues; Returns number of rows in the result set. @@ -40,17 +42,9 @@ - - &reftitle.seealso; - - maxdb_affected_rows - maxdb_store_result - maxdb_use_result - maxdb_query - - - - Example + + + &reftitle.examples; Object oriented style @@ -120,6 +114,19 @@ Result set has 15 rows. ]]> + + + &reftitle.seealso; + + + maxdb_affected_rows + maxdb_store_result + maxdb_use_result + maxdb_query + + + + + maxdb_options maxdb->options Set options - - Description + + + &reftitle.description; Procedural style: boolmaxdb_options @@ -112,23 +113,31 @@ - + + &reftitle.returnvalues; &return.success; - - &reftitle.seealso; + + + &reftitle.examples; - maxdb_init, - maxdb_real_connect + See maxdb_real_connect. - - Example - See maxdb_real_connect. + + + &reftitle.seealso; + + + maxdb_init + maxdb_real_connect + + + + maxdb_param_count @@ -14,6 +14,7 @@ &info.function.alias.deprecated; + + maxdb_ping maxdb->ping Pings a server connection, or tries to reconnect if the connection has gone down - - Description + + + &reftitle.description; Procedural style: boolmaxdb_ping @@ -32,14 +33,16 @@ necessary. - - Return values + + + &reftitle.returnvalues; &return.success; - - Example + + + &reftitle.examples; Object oriented style @@ -101,6 +104,7 @@ Our connection is ok! ]]> + + maxdb_prepare maxdb->prepare Prepare a SQL statement for execution - - Description + + + &reftitle.description; Procedure style: resourcemaxdb_prepare @@ -61,24 +62,16 @@ before executing the statement or fetching rows. - + + &reftitle.returnvalues; maxdb_prepare returns a statement resource or &false; if an error occured. - - &reftitle.seealso; - - maxdb_stmt_execute, - maxdb_stmt_fetch, - maxdb_stmt_bind_param, - maxdb_stmt_bind_result, - maxdb_stmt_close - - - - Example + + + &reftitle.examples; Object oriented style @@ -172,6 +165,20 @@ Rosemont is in district IL ]]> + + + &reftitle.seealso; + + + maxdb_stmt_execute + maxdb_stmt_fetch + maxdb_stmt_bind_param + maxdb_stmt_bind_result + maxdb_stmt_close + + + + + maxdb_query maxdb->query Performs a query on the database - - Description + + + &reftitle.description; Procedural style: mixedmaxdb_query @@ -30,24 +31,18 @@ link parameter. - - Return values + + + &reftitle.returnvalues; &return.success; For SELECT, SHOW, DESCRIBE or EXPLAIN maxdb_query will return a result resource. - - See also - - maxdb_real_query, - maxdb_multi_query, - maxdb_free_result - - - - Example + + + &reftitle.examples; Object oriented style @@ -130,6 +125,18 @@ Select returned 25 rows. ]]> + + + &reftitle.seealso; + + + maxdb_real_query + maxdb_multi_query + maxdb_free_result + + + + + maxdb_real_connect maxdb->real_connect Opens a connection to a MaxDB server - - Description + + + &reftitle.description; Procedural style boolmaxdb_real_connect @@ -55,24 +56,16 @@ - + + &reftitle.returnvalues; &return.success; - - &reftitle.seealso; - - maxdb_connect, - maxdb_init, - maxdb_options, - maxdb_ssl_set, - maxdb_close. - - - - Example + + + &reftitle.examples; Object oriented style @@ -140,6 +133,20 @@ Connection: localhost <...> ]]> + + + &reftitle.seealso; + + + maxdb_connect + maxdb_init + maxdb_options + maxdb_ssl_set + maxdb_close + + + + + maxdb_real_escape_string maxdb->real_escape_string Escapes special characters in a string for use in a SQL statement, taking into account the current charset of the connection - - Description + + + &reftitle.description; Procedural style: stringmaxdb_real_escape_string @@ -32,20 +33,16 @@ Characters encoded are ', ". - - Return values + + + &reftitle.returnvalues; Returns an escaped string. - - See also - - maxdb_character_set_name. - - - - Example + + + &reftitle.examples; Object oriented style @@ -125,6 +122,16 @@ Error: 42000 ]]> + + + &reftitle.seealso; + + + maxdb_character_set_name + + + + + maxdb_real_query maxdb->real_query Execute an SQL query - - Description + + + &reftitle.description; Procedural style boolmaxdb_real_query @@ -34,20 +35,25 @@ - - Return values + + + &reftitle.returnvalues; &return.success; - - See also + + + &reftitle.seealso; - maxdb_query - maxdb_store_result - maxdb_use_result + + maxdb_query + maxdb_store_result + maxdb_use_result + + + maxdb_report Enables or disables internal report functions - - Description + + + &reftitle.description; boolmaxdb_report intflags - - Example + + + &reftitle.examples; Procedural style @@ -47,6 +49,7 @@ Warning: maxdb_query(): -4004 POS(18) Unknown table name:NONEXISTINGTABLE <...> ]]> + + maxdb_rollback maxdb->rollback Rolls back current transaction - - Description + + + &reftitle.description; boolmaxdb_rollback resourcelink @@ -25,21 +26,16 @@ link parameter. - - Return values + + + &reftitle.returnvalues; &return.success; - - See also - - maxdb_commit - maxdb_autocommit - - - - Example + + + &reftitle.examples; Object oriented style @@ -150,6 +146,17 @@ maxdb_close($link); ]]> + + + &reftitle.seealso; + + + maxdb_commit + maxdb_autocommit + + + + + maxdb_rpl_parse_enabled Check if RPL parse is enabled - - Description + + + &reftitle.description; intmaxdb_rpl_parse_enabled resourcelink @@ -15,6 +16,7 @@ &warn.undocumented.func; + + maxdb_rpl_probe RPL probe - - Description + + + &reftitle.description; boolmaxdb_rpl_probe resourcelink @@ -15,6 +16,7 @@ &warn.undocumented.func; + + maxdb_rpl_query_type maxdb->rpl_query_type Returns RPL query type - - Description + + + &reftitle.description; intmaxdb_rpl_query_type resourcelink @@ -24,6 +25,7 @@ &warn.undocumented.func; + + maxdb_select_db maxdb->select_db Selects the default database for database queries - - Description + + + &reftitle.description; boolmaxdb_select_db resourcelink @@ -26,21 +27,16 @@ - - Return values + + + &reftitle.returnvalues; &return.success; - - See also - - maxdb_connect - maxdb_real_connect - - - - Example + + + &reftitle.examples; Object oriented style @@ -126,6 +122,17 @@ Warning: maxdb_close(): -10821 Session not connected [] <...> ]]> + + + &reftitle.seealso; + + + maxdb_connect + maxdb_real_connect + + + + + maxdb_send_long_data @@ -14,6 +14,7 @@ &info.function.alias.deprecated; + + maxdb_send_query maxdb->send_query Send the query and return - - Description + + + &reftitle.description; boolmaxdb_send_query resourcelink @@ -25,6 +26,7 @@ &warn.undocumented.func; + + maxdb_server_end Shut down the embedded server - - Description + + + &reftitle.description; voidmaxdb_server_end @@ -15,6 +16,7 @@ &warn.undocumented.func; + + maxdb_server_init Initialize embedded server - - Description + + + &reftitle.description; boolmaxdb_server_init arrayserver @@ -16,6 +17,7 @@ &warn.undocumented.func; + + maxdb_set_opt @@ -13,6 +13,7 @@ maxdb_options. + + maxdb_sqlstate maxdb->sqlstate Returns the SQLSTATE error from previous MaxDB operation - - Description + + + &reftitle.description; Procedural style: stringmaxdb_sqlstate @@ -30,22 +31,17 @@ - - Return values + + + &reftitle.returnvalues; Returns a string containing the SQLSTATE error code for the last error. The error code consists of five characters. '00000' means no error. - - See also - - maxdb_errno, - maxdb_error - - - - Example + + + &reftitle.examples; Object oriented style @@ -102,6 +98,17 @@ Error - SQLSTATE I6000. ]]> + + + &reftitle.seealso; + + + maxdb_errno + maxdb_error + + + + + maxdb_ssl_set maxdb->ssl_set Used for establishing secure connections using SSL - - Description + + + &reftitle.description; Procedural style: boolmaxdb_ssl_set @@ -34,6 +35,7 @@ &warn.undocumented.func; + + maxdb_stat maxdb->stat Gets the current system status - - Description + + + &reftitle.description; Procedural style: stringmaxdb_stat @@ -26,20 +27,16 @@ information about the MaxDB server running. - - Return values + + + &reftitle.returnvalues; A string describing the server status. &false; if an error occurred. - - See also - - maxdb_get_server_info - - - - Example + + + &reftitle.examples; Object oriented style @@ -89,6 +86,16 @@ System status: Kernel 7<...> ]]> + + + &reftitle.seealso; + + + maxdb_get_server_info + + + + + maxdb_stmt_affected_rows @@ -8,8 +8,9 @@ inserted by the last executed statement - - Description + + + &reftitle.description; Procedural style : intmaxdb_stmt_affected_rows @@ -26,8 +27,9 @@ number of rows can not determined, this function will return -1. - - Return Values + + + &reftitle.returnvalues; An integer greater than zero indicates the number of rows affected or retrieved. Zero indicates that no records where updated for an UPDATE/DELETE statement, no @@ -35,15 +37,9 @@ -1 indicates that the query has returned an error or the number of rows can not determined. - - See also - - maxdb_stmt_num_rows, - maxdb_prepare - - - - Example + + + &reftitle.examples; Object oriented style @@ -133,6 +129,17 @@ rows inserted: 4 ]]> + + + &reftitle.seealso; + + + maxdb_stmt_num_rows + maxdb_prepare + + + + + maxdb_stmt_bind_param stmt->bind_param Binds variables to a prepared statement as parameters - - Description + + + &reftitle.description; Procedural style: boolmaxdb_stmt_bind_param @@ -104,26 +105,16 @@ - - Return values + + + &reftitle.returnvalues; &return.success; - - See also - - maxdb_stmt_bind_result, - maxdb_stmt_execute, - maxdb_stmt_fetch, - maxdb_prepare, - maxdb_stmt_send_long_data, - maxdb_stmt_errno, - maxdb_stmt_error - - - - Example + + + &reftitle.examples; Object oriented style @@ -374,6 +365,22 @@ $maxdb->close(); ]]> + + + &reftitle.seealso; + + + maxdb_stmt_bind_result + maxdb_stmt_execute + maxdb_stmt_fetch + maxdb_prepare + maxdb_stmt_send_long_data + maxdb_stmt_errno + maxdb_stmt_error + + + + + maxdb_stmt_bind_result stmt->bind_result Binds variables to a prepared statement for result storage - - Description + + + &reftitle.description; Procedural style: boolmaxdb_stmt_bind_result @@ -42,27 +43,16 @@ - - Return values + + + &reftitle.returnvalues; &return.success; - - See also - - maxdb_stmt_bind_param, - maxdb_stmt_execute, - maxdb_stmt_fetch, - maxdb_prepare, - maxdb_stmt_prepare, - maxdb_stmt_init, - maxdb_stmt_errno, - maxdb_stmt_error - - - - Example + + + &reftitle.examples; Object oriented style @@ -165,6 +155,23 @@ maxdb_close($link); ]]> + + + &reftitle.seealso; + + + maxdb_stmt_bind_param + maxdb_stmt_execute + maxdb_stmt_fetch + maxdb_prepare + maxdb_stmt_prepare + maxdb_stmt_init + maxdb_stmt_errno + maxdb_stmt_error + + + + + maxdb_stmt_close_long_data stmt->close_long_data Ends a sequence of maxdb_stmt_send_long_data - - Description + + + &reftitle.description; Procedural style: boolmaxdb_stmt_close_long_data @@ -33,19 +34,24 @@ Parameters are numbered beginning with 0. - + + &reftitle.returnvalues; &return.success; - + + &reftitle.seealso; - maxdb_prepare, - maxdb_stmt_bind_param + + maxdb_prepare + maxdb_stmt_bind_param + + + maxdb_stmt_close maxdb_stmt->close Closes a prepared statement - - Description + + + &reftitle.description; Procedural style: boolmaxdb_stmt_close @@ -28,18 +29,23 @@ the next query can be executed. - - Return values + + + &reftitle.returnvalues; &return.success; - - See also + + + &reftitle.seealso; - maxdb_prepare, + + maxdb_prepare + + + maxdb_stmt_data_seek stmt->data_seek Seeks to an arbitray row in statement result set - - Description + + + &reftitle.description; Procedural style: boolmaxdb_stmt_data_seek @@ -30,20 +31,16 @@ zero and the total number of rows minus one (0..maxdb_stmt_num_rows - 1). - - Return values + + + &reftitle.returnvalues; &return.success; - - See also - - maxdb_prepare - - - - Example + + + &reftitle.examples; Object oriented style @@ -141,6 +138,16 @@ City: Dallas Zip: 75243 ]]> + + + &reftitle.seealso; + + + maxdb_prepare + + + + + maxdb_stmt_errno maxdb_stmt->errno Returns the error code for the most recent statement call - - Description + + + &reftitle.description; Procedural style : intmaxdb_stmt_errno @@ -29,21 +30,26 @@ - - Return values + + + &reftitle.returnvalues; An error code value. Zero means no error occurred. - - See also + + + &reftitle.seealso; - maxdb_stmt_error, - maxdb_stmt_sqlstate + + maxdb_stmt_error + maxdb_stmt_sqlstate + - - Example + + + &reftitle.examples; Object oriented style @@ -132,6 +138,17 @@ Error: -4004. ]]> + + + &reftitle.seealso; + + + maxdb_stmt_error + maxdb_stmt_sqlstate + + + + + maxdb_stmt_error maxdb_stmt->error Returns a string description for last statement error - - Description + + + &reftitle.description; Procedural style: stringmaxdb_stmt_error @@ -24,21 +25,16 @@ can succeed or fail. - - Return values + + + &reftitle.returnvalues; A string that describes the error. An empty string if no error occurred. - - See also - - maxdb_stmt_errno, - maxdb_stmt_sqlstate - - - - Example + + + &reftitle.examples; Object oriented style @@ -127,6 +123,17 @@ Error: POS(23) Unknown table name:MYCITY. ]]> + + + &reftitle.seealso; + + + maxdb_stmt_errno + maxdb_stmt_sqlstate + + + + + maxdb_stmt_execute stmt->execute Executes a prepared Query - - Description + + + &reftitle.description; Procedural style: boolmaxdb_stmt_execute @@ -40,21 +41,16 @@ - - Return values + + + &reftitle.returnvalues; &return.success; - - See also - - maxdb_prepare - maxdb_stmt_bind_param. - - - - Example + + + &reftitle.examples; Object oriented style @@ -179,6 +175,17 @@ maxdb_close($link); ]]> + + + &reftitle.seealso; + + + maxdb_prepare + maxdb_stmt_bind_param + + + + + maxdb_stmt_fetch stmt->fetch Fetch results from a prepared statement into the bound variables - - Description + + + &reftitle.description; Procedural style: boolmaxdb_stmt_fetch @@ -31,8 +32,9 @@ - - Return values + + + &reftitle.returnvalues; Return values @@ -59,17 +61,9 @@
- - See also - - maxdb_prepare, - maxdb_stmt_errno, - maxdb_stmt_error, - maxdb_stmt_bind_result - - - - Example + + + &reftitle.examples; Object oriented style @@ -179,6 +173,19 @@ maxdb_close($link); ]]> + + + &reftitle.seealso; + + + maxdb_prepare + maxdb_stmt_errno + maxdb_stmt_error + maxdb_stmt_bind_result + + + + + maxdb_stmt_free_result stmt->free_result Frees stored result memory for the given statement handle - - Description + + + &reftitle.description; Procedural style: voidmaxdb_stmt_free_result @@ -29,16 +30,20 @@ maxdb_stmt_store_result. - + + &reftitle.returnvalues; This function doesn't return any value. - + + &reftitle.seealso; - maxdb_stmt_store_result + + maxdb_stmt_store_result + diff --git a/reference/maxdb/functions/maxdb-stmt-init.xml b/reference/maxdb/functions/maxdb-stmt-init.xml index 27310088aa..aa338d7670 100644 --- a/reference/maxdb/functions/maxdb-stmt-init.xml +++ b/reference/maxdb/functions/maxdb-stmt-init.xml @@ -1,13 +1,14 @@ - + maxdb_stmt_init maxdb->stmt_init Initializes a statement and returns an resource for use with maxdb_stmt_prepare - - Description + + + &reftitle.description; Procedural style : resourcemaxdb_stmt_init @@ -32,18 +33,23 @@ - + + &reftitle.returnvalues; Returns an resource. - + + &reftitle.seealso; - maxdb_stmt_prepare + + maxdb_stmt_prepare + + + maxdb_stmt_num_rows stmt->num_rows Return the number of rows in statements result set - - Description + + + &reftitle.description; Procedural style : intmaxdb_stmt_num_rows @@ -22,22 +23,16 @@ Returns the number of rows in the result set. - - Return values + + + &reftitle.returnvalues; An integer representing the number of rows in result set. - - See also - - maxdb_stmt_affected_rows, - maxdb_prepare, - maxdb_stmt_store_result - - - - Example + + + &reftitle.examples; Object oriented style @@ -117,6 +112,18 @@ Number of rows: 25. ]]> + + + &reftitle.seealso; + + + maxdb_stmt_affected_rows + maxdb_prepare + maxdb_stmt_store_result + + + + + maxdb_stmt_param_count stmt->param_count Returns the number of parameter for the given statement - - Description + + + &reftitle.description; Procedural style: intmaxdb_stmt_param_count @@ -23,20 +24,16 @@ markers present in the prepared statement. - + + &reftitle.returnvalues; returns an integer representing the number of parameters. - - &reftitle.seealso; - - maxdb_prepare - - - - Example + + + &reftitle.examples; Object oriented style @@ -102,6 +99,16 @@ Statement has 2 markers. ]]> + + + &reftitle.seealso; + + + maxdb_prepare + + + + + maxdb_stmt_prepare stmt->prepare Prepare a SQL statement for execution - - Description + + + &reftitle.description; Procedure style: boolmaxdb_stmt_prepare @@ -63,25 +64,16 @@ before executing the statement or fetching rows. - + + &reftitle.returnvalues; &return.success; - - &reftitle.seealso; - - maxdb_stmt_init, - maxdb_stmt_execute, - maxdb_stmt_fetch, - maxdb_stmt_bind_param, - maxdb_stmt_bind_result, - maxdb_stmt_close - - - - Example + + + &reftitle.examples; Object oriented style @@ -177,6 +169,21 @@ Portland is in district OR ]]> + + + &reftitle.seealso; + + + maxdb_stmt_init + maxdb_stmt_execute + maxdb_stmt_fetch + maxdb_stmt_bind_param + maxdb_stmt_bind_result + maxdb_stmt_close + + + + + maxdb_stmt_reset stmt->reset Resets a prepared statement - - Description + + + &reftitle.description; Procedural style: boolmaxdb_stmt_reset @@ -25,6 +26,7 @@ &warn.undocumented.func; + + maxdb_stmt_result_metadata Returns result set metadata from a prepared statement - - Description + + + &reftitle.description; Procedural style: resourcemaxdb_stmt_result_metadata @@ -53,22 +54,17 @@ - + + &reftitle.returnvalues; maxdb_stmt_result_metadata returns a result resource or &false; if an error occured. - - See also: - - maxdb_prepare, - maxdb_free_result - - - - Example + + + &reftitle.examples; Object oriented style @@ -144,6 +140,17 @@ Fieldname: ID ]]> + + + &reftitle.seealso; + + + maxdb_prepare + maxdb_free_result + + + + + maxdb_stmt_send_long_data stmt->send_long_data Send data in blocks - - Description + + + &reftitle.description; Procedural style: boolmaxdb_stmt_send_long_data @@ -43,19 +44,24 @@ - + + &reftitle.returnvalues; &return.success; - + + &reftitle.seealso; - maxdb_prepare, - maxdb_stmt_bind_param + + maxdb_prepare + maxdb_stmt_bind_param + + + maxdb_stmt_sqlstate Returns SQLSTATE error from previous statement operation - - Description + + + &reftitle.description; stringmaxdb_stmt_sqlstate resourcestmt @@ -24,22 +25,17 @@ - - Return values + + + &reftitle.returnvalues; Returns a string containing the SQLSTATE error code for the last error. The error code consists of five characters. '00000' means no error. - - See also - - maxdb_stmt_errno, - maxdb_stmt_error - - - - Example + + + &reftitle.examples; Object oriented style @@ -126,6 +122,17 @@ Error: 42000. ]]> + + + &reftitle.seealso; + + + maxdb_stmt_errno + maxdb_stmt_error + + + + + maxdb_stmt_store_result maxdb->store_result Transfers a result set from a prepared statement - - Description + + + &reftitle.description; Procedural style: boolmaxdb_stmt_store_result @@ -27,22 +28,16 @@ and should not be used for retrieving data from MaxDB server. - - Return values + + + &reftitle.returnvalues; &return.success; - - See also - - maxdb_prepare, - maxdb_stmt_result_metadata, - maxdb_fetch - - - - Example + + + &reftitle.examples; Object oriented style @@ -128,6 +123,18 @@ Number of rows: 25. ]]> + + + &reftitle.seealso; + + + maxdb_prepare + maxdb_stmt_result_metadata + maxdb_fetch + + + + + maxdb_store_result maxdb->store_result Transfers a result set from the last query - - Description + + + &reftitle.description; Procedural style: resourcemaxdb_store_result @@ -26,25 +27,31 @@ This function has no functionally effect. - - Return values + + + &reftitle.returnvalues; Returns a result resource or &false; if an error occurred. - - See also - - maxdb_real_query, - maxdb_use_result. - - - - Example + + + &reftitle.examples; See maxdb_multi_query. + + + &reftitle.seealso; + + + maxdb_real_query + maxdb_use_result + + + + + maxdb_thread_id maxdb->thread_id Returns the thread ID for the current connection - - Description + + + &reftitle.description; Procedural style: intmaxdb_thread_id @@ -33,20 +34,16 @@ - - Return values + + + &reftitle.returnvalues; maxdb_thread_id returns the Thread ID for the current connection. - - See also - - maxdb_kill - - - - Example + + + &reftitle.examples; Object oriented style @@ -119,6 +116,16 @@ Error: Session not connected ]]> + + + &reftitle.seealso; + + + maxdb_kill + + + + + maxdb_thread_safe Returns whether thread safety is given or not - - Description + + + &reftitle.description; Procedural style: boolmaxdb_thread_safe @@ -17,12 +18,14 @@ client library is compiled as thread-safe. - - Return values + + + &reftitle.returnvalues; &true; if the client library is thread-safe, otherwise &false;. + + maxdb_use_result maxdb->use_result Initiate a result set retrieval - - Description + + + &reftitle.description; Procedural style: resourcemaxdb_use_result @@ -25,21 +26,16 @@ maxdb_use_result has no effect. - - Return values + + + &reftitle.returnvalues; Returns result or &false; in case of error. - - See also - - maxdb_real_query, - maxdb_store_result. - - - - Example + + + &reftitle.examples; Object oriented style @@ -125,6 +121,17 @@ a ]]> + + + &reftitle.seealso; + + + maxdb_real_query + maxdb_store_result + + + + + maxdb_warning_count maxdb->warning_count Returns the number of warnings from the last query for the given link - - Description + + + &reftitle.description; Procedural style: intmaxdb_warning_count @@ -24,22 +25,16 @@ link parameter. - - Return values + + + &reftitle.returnvalues; Number of warnings or zero if there are no warnings. - - See also - - maxdb_errno, - maxdb_error, - maxdb_sqlstate - - - - Example + + + &reftitle.examples; Object oriented style @@ -108,6 +103,18 @@ Number of warning: 0 ]]> + + + &reftitle.seealso; + + + maxdb_errno + maxdb_error + maxdb_sqlstate + + + +