include/util-func.h

   1 /*
   2  * libslp-db-util
   3  *
   4  * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: Hakjoo Ko <hakjoo.ko@samsung.com>
   7  *
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  *
  20  */
  21
  22 #ifndef __UTIL_FUNC_H__
  23 #define __UTIL_FUNC_H__
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 #include <db-util-common.h>
  30
  31 /**
  32  * @defgroup DB_UTIL DB Util
  33  * @brief This provides functions to handle DB.
  34  * @ingroup StorageFW
  35  * @section DB_UTIL_HEADER Required Header
  36  *   \#include <db-util.h>
  37  */
  38
  39 /**
  40  * @addtogroup DB_UTIL
  41  * @{
  42  */
  43
  44
  45 #define DB_UTIL_REGISTER_HOOK_METHOD    0x00000001
  46 #define DB_UTIL_LUCENE_INDEX            0x00000002
  47
  48 /**
  49  * @brief invoke sqlite3_open with platform common configuration
  50  * @details register busy handler, create localized collation
  51  * @param [in] database file name (UTF-8)
  52  * @param [out] SQLite database handle
  53  * @param [in] option value
  54  * @return sqlite3 function return value will be returned
  55  * @see db_util_open_with_options()
  56  * @see db_util_close()
  57  *
  58  */
  59 EXPORT_API int db_util_open(const char *pszFilePath, sqlite3 **ppDB,
  60                                                 int nOption);
  61
  62 /**
  63  * @brief invoke sqlite3_open_v2 with platform common configuration
  64  * @details register busy handler, create localized collation
  65  * @param [in] database file name (UTF-8)
  66  * @param [out] SQLite database handle
  67  * @param [in] sqlite3_open_v2 flags
  68  * @param [in] Name of VFS module to use
  69  * @return sqlite3 function return value will be returned
  70  * @see db_util_open()
  71  * @see db_util_close()
  72  *
  73  */
  74 EXPORT_API int db_util_open_with_options(const char *pszFilePath,
  75                                                 sqlite3 **ppDB, int flags,
  76                                                 const char *zVfs);
  77
  78 /**
  79  * @brief closing a database connection
  80  * @param [in] SQLite database handle
  81  * @return sqlite3_close function return value will be returned
  82  * @see db_util_open()
  83  * @see db_util_open_with_options()
  84  *
  85  */
  86 EXPORT_API int db_util_close(sqlite3 *ppDB);
  87
  88 /**
  89  * @}
  90  */
  91
  92 #ifdef __cplusplus
  93 }
  94 #endif
  95 #endif  /* __UTIL_FUNC_H__ */