[asterisk-commits] tilghman: branch tilghman/odbc_tx_support r164198 - /team/tilghman/odbc_tx_su...

[SVN commits to the Asterisk project]

Author: tilghman
Date: Sun Dec 14 12:48:22 2008
New Revision: 164198

URL: http://svn.digium.com/view/asterisk?view=rev&rev=164198
Log:
Add some documentation

Modified:
    team/tilghman/odbc_tx_support/include/asterisk/res_odbc.h

Modified: team/tilghman/odbc_tx_support/include/asterisk/res_odbc.h
URL: http://svn.digium.com/view/asterisk/team/tilghman/odbc_tx_support/include/asterisk/res_odbc.h?view=diff&rev=164198&r1=164197&r2=164198
==============================================================================
--- team/tilghman/odbc_tx_support/include/asterisk/res_odbc.h (original)
+++ team/tilghman/odbc_tx_support/include/asterisk/res_odbc.h Sun Dec 14 12:48:22 2008
@@ -34,6 +34,7 @@
 
 typedef enum { ODBC_SUCCESS=0, ODBC_FAIL=-1} odbc_status;
 
+/*! \brief Flags for use with ast_odbc_request_obj2 */
 enum {
 	RES_ODBC_SANITY_CHECK = (1 << 0),
 	RES_ODBC_INDEPENDENT_CONNECTION = (1 << 1),
@@ -126,6 +127,16 @@
 struct odbc_obj *ast_odbc_request_obj(const char *name, int check);
 #endif
 
+/*!
+ * \brief Retrieve a stored ODBC object, if a transaction has been started.
+ * \param chan Channel associated with the transaction.
+ * \param objname Name of the database handle.  This name corresponds to the name passed
+ * to ast_odbc_request_obj2 (or formerly, to ast_odbc_request_obj).  Note that the
+ * existence of this parameter name explicitly allows for multiple transactions to be open
+ * at once, albeit to different databases.
+ * \retval A stored ODBC object, if a transaction was already started.
+ * \retval NULL, if no transaction yet exists.
+ */
 struct odbc_obj *ast_odbc_retrieve_transaction_obj(struct ast_channel *chan, const char *objname);
 
 /*!