Date: Tuesday, March 21, 2006 @ 17:26:41
Author: marc
Path: /cvsroot/carob/carob/include
Modified: Statement.hpp (1.35 -> 1.36)
Enhanced doxygen of getMetaData()
---------------+
Statement.hpp | 13 +++++++------
1 files changed, 7 insertions(+), 6 deletions(-)
Index: carob/include/Statement.hpp
diff -u carob/include/Statement.hpp:1.35 carob/include/Statement.hpp:1.36
--- carob/include/Statement.hpp:1.35 Wed Mar 15 19:52:54 2006
+++ carob/include/Statement.hpp Tue Mar 21 17:26:41 2006
@@ -315,11 +315,12 @@
*/
virtual void close();
/**
- * If called before executing request that returned a valid resultset, this
- * method prepares the current statement and returns the corresponding
- * metadata.
- * If called after a read request (ie. if the current resultset pointer is
non
- * NULL), returns the current resultset's metadata
+ * Returns the metadata of the current or future ResultSet. Note
+ * that if there is no ResultSet available yet (before execution),
+ * then this method will generate some network communication to the
+ * controller. No caching is performed here: before execution this
+ * network communication will happen at every call.
+ *
* @return a pointer to the metadata of this statement or of its resultset
*/
ResultSetMetaData* getMetaData() throw (SocketIOException,
@@ -373,7 +374,7 @@
/** Current result for a read request */
DriverResultSet* lastResultPtr;
/**
- * ResultSet containing the metadata got from
+ * Empty ResultSet just to hold the metadata got from
* Connection#preparedStatementGetMetaData(Request)
*/
DriverResultSet* metadata_holder_ptr;
_______________________________________________
Carob-commits mailing list
[email protected]
https://forge.continuent.org/mailman/listinfo/carob-commits
