modules: several small doxygen bug fixes
[sip-router] / modules / db_mysql / km_res.h
1 /* 
2  * $Id$ 
3  *
4  * MySQL module result related functions
5  *
6  * Copyright (C) 2001-2003 FhG Fokus
7  * Copyright (C) 2007-2008 1&1 Internet AG
8  *
9  * This file is part of Kamailio, a free SIP server.
10  *
11  * Kamailio is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version
15  *
16  * Kamailio is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License 
22  * along with this program; if not, write to the Free Software 
23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
24  */
25
26 /*! \file
27  *  \brief DB_MYSQL :: Result related functions
28  *  \ingroup db_mysql
29  *  Module: \ref db_mysql
30  */
31
32
33 #ifndef KM_RES_H
34 #define KM_RES_H
35
36 #include "../../lib/srdb1/db_res.h"
37 #include "../../lib/srdb1/db_con.h"
38
39
40 /*!
41  * \brief Fill the result structure with data from database
42  * \param _h database connection
43  * \param _r database result
44  * \return 0 on success, negative on failure
45  */
46 int db_mysql_convert_result(const db1_con_t* _h, db1_res_t* _r);
47
48
49 /*!
50  * \brief Get and convert columns from a result
51  * \param _h database connection
52  * \param _r database result set
53  * \return 0 on success, negative on failure
54  */
55 int db_mysql_get_columns(const db1_con_t* _h, db1_res_t* _r);
56
57 #endif