Date: Thursday, January 26, 2006 @ 11:56:28
Author: zsolt
Path: /cvsroot/carob/libmysequoia/src
Modified: MySQLAPI.cpp (1.33 -> 1.34)
Commenting functions
--------------+
MySQLAPI.cpp | 45 +++++++++++++++++++++++++++++++++++++++++++++
1 files changed, 45 insertions(+)
Index: libmysequoia/src/MySQLAPI.cpp
diff -u libmysequoia/src/MySQLAPI.cpp:1.33 libmysequoia/src/MySQLAPI.cpp:1.34
--- libmysequoia/src/MySQLAPI.cpp:1.33 Thu Jan 26 11:21:04 2006
+++ libmysequoia/src/MySQLAPI.cpp Thu Jan 26 11:56:28 2006
@@ -318,6 +318,7 @@
return result;
}
+/* Checks whether the connection to the server is working, reconnecting as
necessary. */
int STDCALL
mysql_ping (MYSQL * mysql)
{
@@ -437,6 +438,8 @@
return result;
}
+/* Determines whether the last row of a result set has been read.
+ * This function is deprecated; mysql_errno() or mysql_error() may be used
instead. */
my_bool STDCALL
mysql_eof (MYSQL_RES * res)
{
@@ -447,6 +450,7 @@
return result;
}
+/* Checks whether any more results exist. */
my_bool STDCALL
mysql_more_results (MYSQL * mysql)
{
@@ -458,6 +462,7 @@
return result;
}
+/* Returns/initiates the next result in multiple-statement executions. */
int STDCALL
mysql_next_result (MYSQL * mysql)
{
@@ -737,6 +742,7 @@
return result;
}
+/* Returns the warning count for the previous SQL statement. */
unsigned int STDCALL
mysql_warning_count (MYSQL * mysql)
{
@@ -749,6 +755,7 @@
return result;
}
+/* Does a DBUG_PUSH with the given string. */
void STDCALL
mysql_debug (const char *debug)
{
@@ -761,6 +768,7 @@
/* Misc functions */
+/* Escapes special characters in a string for use in an SQL statement. */
unsigned long STDCALL
mysql_escape_string (char *to, const char *from, unsigned long length)
{
@@ -772,6 +780,8 @@
return result;
}
+/* Escapes special characters in a string for use in an SQL statement,
+ * taking into account the current charset of the connection. */
unsigned long STDCALL
mysql_real_escape_string (MYSQL * mysql, char *to, const char *from, unsigned
long length)
{
@@ -833,6 +843,7 @@
return result;
}
+/* Returns the name of the default character set for the connection. */
const char *
mysql_character_set_name (MYSQL * mysql)
{
@@ -910,6 +921,7 @@
return result;
}
+/* Shuts down the database server. */
int STDCALL
mysql_shutdown (MYSQL * mysql, enum mysql_enum_shutdown_level shutdown_level)
{
@@ -1060,6 +1072,7 @@
return result;
}
+/* Returns a list of the current server threads. */
MYSQL_RES *STDCALL
mysql_list_processes (MYSQL * mysql)
{
@@ -1084,6 +1097,7 @@
return result;
}
+/* Returns the server status as a string. */
const char *STDCALL
mysql_stat (MYSQL * mysql)
{
@@ -1098,6 +1112,7 @@
/* Thread functions */
+/* This function needs to be called for each created thread to initialize
thread-specific variables. */
my_bool
mysql_thread_init (void)
{
@@ -1106,6 +1121,7 @@
return 0;
}
+/* This function needs to be called before calling pthread_exit() to free
memory allocated by mysql_thread_init(). */
void
mysql_thread_end (void)
{
@@ -1113,6 +1129,7 @@
LOG4CXX_DEBUG(logger, "Leaving mysql_thread_end.");
}
+/* Returns the current thread ID. */
unsigned long STDCALL
mysql_thread_id (MYSQL * mysql)
{
@@ -1121,6 +1138,7 @@
return 0;
}
+/* This function indicates whether the client is compiled as thread-safe. */
unsigned int STDCALL
mysql_thread_safe (void)
{
@@ -1131,6 +1149,7 @@
/* Prepared statements */
+/* Allocates memory for MYSQL_STMT structure and initializes it. */
MYSQL_STMT *
mysql_stmt_init (MYSQL * mysql)
{
@@ -1150,6 +1169,7 @@
return result;
}
+/* Frees memory used by prepared statement. */
my_bool
mysql_stmt_close (MYSQL_STMT *stmt)
{
@@ -1162,6 +1182,7 @@
return 0;
}
+/* Get value of an attribute for a prepared statement. */
my_bool
mysql_stmt_attr_get (MYSQL_STMT * stmt, enum enum_stmt_attr_type option,
void *arg)
@@ -1201,6 +1222,7 @@
return result;
}
+/* Sets an attribute for a prepared statement. */
my_bool
mysql_stmt_attr_set (MYSQL_STMT * stmt, enum enum_stmt_attr_type option,
const void *arg)
@@ -1253,6 +1275,7 @@
return result;
}
+/* Prepares an SQL string for execution. */
int
mysql_stmt_prepare (MYSQL_STMT * stmt, const char *query,
unsigned long length)
@@ -1273,6 +1296,7 @@
return result;
}
+/* Associates application data buffers with the parameter markers in a
prepared SQL statement. */
my_bool
mysql_stmt_bind_param (MYSQL_STMT * stmt, MYSQL_BIND * bind)
{
@@ -1293,6 +1317,7 @@
return result;
}
+/* Executes the prepared statement. */
int
mysql_stmt_execute (MYSQL_STMT * stmt)
{
@@ -1313,6 +1338,7 @@
return result;
}
+/* Associates application data buffers with columns in the result set. */
my_bool
mysql_stmt_bind_result (MYSQL_STMT * stmt, MYSQL_BIND * bind)
{
@@ -1333,6 +1359,7 @@
return result;
}
+/* Returns the error number for the last statement execution. */
unsigned int
mysql_stmt_errno (MYSQL_STMT * stmt)
{
@@ -1344,6 +1371,7 @@
return result;
}
+/* Returns the error message for the last statement execution. */
const char *
mysql_stmt_error (MYSQL_STMT * stmt)
{
@@ -1355,6 +1383,7 @@
return result;
}
+/* Returns the SQLSTATE error code for the last statement execution. */
const char *
mysql_stmt_sqlstate (MYSQL_STMT * stmt)
{
@@ -1366,6 +1395,7 @@
return result;
}
+/* Returns the number of rows changes, deleted, or inserted by prepared
UPDATE, DELETE, or INSERT statement. */
my_ulonglong
mysql_stmt_affected_rows (MYSQL_STMT * stmt)
{
@@ -1377,6 +1407,7 @@
return result;
}
+/* Seeks to an arbitrary row number in a statement result set. */
void
mysql_stmt_data_seek (MYSQL_STMT * stmt, my_ulonglong offset)
{
@@ -1392,6 +1423,7 @@
LOG4CXX_DEBUG(logger, "Leaving mysql_stmt_data_seek.");
}
+/* Fetches the next row of data from the result set and returns data for all
bound columns. */
int
mysql_stmt_fetch (MYSQL_STMT * stmt)
{
@@ -1412,6 +1444,7 @@
return result;
}
+/* Fetch data for one column of the current row of the result set. */
int
mysql_stmt_fetch_column (MYSQL_STMT * stmt, MYSQL_BIND * bind,
unsigned int column, unsigned long offset)
@@ -1432,6 +1465,7 @@
return result;
}
+/* Returns the number of result columns for the most recent statement. */
unsigned int
mysql_stmt_field_count (MYSQL_STMT * stmt)
{
@@ -1443,6 +1477,7 @@
return result;
}
+/* Free the resources allocated to the statement handle. */
my_bool
mysql_stmt_free_result (MYSQL_STMT * stmt)
{
@@ -1459,6 +1494,7 @@
return result;
}
+/* Returns the ID generated for an AUTO_INCREMENT column by prepared
statement. */
my_ulonglong
mysql_stmt_insert_id (MYSQL_STMT * stmt)
{
@@ -1471,6 +1507,7 @@
return result;
}
+/* Returns total rows from the statement buffered result set. */
my_ulonglong
mysql_stmt_num_rows (MYSQL_STMT * stmt)
{
@@ -1482,6 +1519,7 @@
return result;
}
+/* Returns the number of parameters in a prepared SQL statement. */
unsigned long
mysql_stmt_param_count (MYSQL_STMT * stmt)
{
@@ -1493,6 +1531,7 @@
return result;
}
+/* Return parameter metadata in the form of a result set. */
MYSQL_RES *
mysql_stmt_param_metadata (MYSQL_STMT * stmt)
{
@@ -1505,6 +1544,7 @@
return result;
}
+/* Reset the statement buffers in the server. */
my_bool
mysql_stmt_reset (MYSQL_STMT * stmt)
{
@@ -1521,6 +1561,7 @@
return result;
}
+/* Returns prepared statement metadata in the form of a result set. */
MYSQL_RES *
mysql_stmt_result_metadata (MYSQL_STMT * stmt)
{
@@ -1532,6 +1573,7 @@
return result;
}
+/* Seeks to a row offset in a statement result set, using value returned from
mysql_stmt_row_tell(). */
MYSQL_ROW_OFFSET
mysql_stmt_row_seek (MYSQL_STMT * stmt, MYSQL_ROW_OFFSET offset)
{
@@ -1551,6 +1593,7 @@
return result;
}
+/* Returns the statement row cursor position. */
MYSQL_ROW_OFFSET
mysql_stmt_row_tell (MYSQL_STMT * stmt)
{
@@ -1562,6 +1605,7 @@
return result;
}
+/* Sends long data in chunks to server. */
my_bool
mysql_stmt_send_long_data (MYSQL_STMT * stmt, unsigned int parameter_number,
const char *data, unsigned long length)
@@ -1579,6 +1623,7 @@
return result;
}
+/* Retrieves the complete result set to the client. */
int
mysql_stmt_store_result (MYSQL_STMT * stmt)
{
_______________________________________________
Carob-commits mailing list
[email protected]
https://forge.continuent.org/mailman/listinfo/carob-commits
