[SR-Dev] git:janakj/mysql: - docs extension: explain fetch_result functionality better to prevent errors

[Jan Janak]

Module: sip-router
Branch: janakj/mysql
Commit: 205f28ce7929d6a43e4c649b9db25bcd70b9d19b
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=205f28ce7929d6a43e4c649b9db25bcd70b9d19b

Author: Henning Westerholt <henning.westerholt at 1und1.de>
Committer: Henning Westerholt <henning.westerholt at 1und1.de>
Date:   Fri Oct 17 08:01:23 2008 +0000

- docs extension: explain fetch_result functionality better to prevent errors
  because of wrong usage, found from Juha Heinanen


git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@5088 689a6050-402a-0410-94f2-e92a70836424

---

 modules/db_mysql/km_dbase.c |   10 +++++++++-
 1 files changed, 9 insertions(+), 1 deletions(-)

diff --git a/modules/db_mysql/km_dbase.c b/modules/db_mysql/km_dbase.c
index 726a881..ecc3106 100644
--- a/modules/db_mysql/km_dbase.c
+++ b/modules/db_mysql/km_dbase.c
@@ -251,7 +251,15 @@ int db_mysql_query(const db_con_t* _h, const db_key_t* _k, const db_op_t* _op,
 }
 
 /**
- * Gets a partial result set.
+ * \brief Gets a partial result set, fetch rows from a result
+ *
+ * Gets a partial result set, fetch a number of rows from a database result.
+ * This function initialize the given result structure on the first run, and
+ * fetches the nrows number of rows. On subsequenting runs, it uses the
+ * existing result and fetches more rows, until it reaches the end of the
+ * result set. Because of this the result needs to be null in the first
+ * invocation of the function. If the number of wanted rows is zero, the
+ * function returns anything with a result of zero.
  * \param _h structure representing the database connection
  * \param _r pointer to a structure representing the result
  * \param nrows number of fetched rows