mirror of
https://gitee.com/openharmony/interface_sdk_c
synced 2024-11-27 00:41:01 +00:00
!1664 Fix function's brief and param
Merge pull request !1664 from Lee/master
This commit is contained in:
openharmony_ci
Gitee
commit
cc6ac75bec
@ -160,14 +160,14 @@ typedef struct {
|
||||
/**
|
||||
* @brief Define OH_Rdb_ConfigV2 type.
|
||||
*
|
||||
* @since 13
|
||||
* @since 14
|
||||
*/
|
||||
typedef struct OH_Rdb_ConfigV2 OH_Rdb_ConfigV2;
|
||||
|
||||
/**
|
||||
* @brief Define Rdb_DBType type.
|
||||
*
|
||||
* @since 13
|
||||
* @since 14
|
||||
*/
|
||||
typedef enum Rdb_DBType {
|
||||
/**
|
||||
@ -191,7 +191,7 @@ typedef enum Rdb_DBType {
|
||||
* The possible cause is that the address space of the application is full, As a result, the space
|
||||
* cannot be allocated.
|
||||
* @see OH_Rdb_ConfigV2
|
||||
* @since 13
|
||||
* @since 14
|
||||
*/
|
||||
OH_Rdb_ConfigV2 *OH_Rdb_CreateConfig();
|
||||
|
||||
@ -203,7 +203,7 @@ OH_Rdb_ConfigV2 *OH_Rdb_CreateConfig();
|
||||
* @return Returns the status code of the execution. Successful execution returns RDB_OK,
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @since 13
|
||||
* @since 14
|
||||
*/
|
||||
int OH_Rdb_DestroyConfig(OH_Rdb_ConfigV2 *config);
|
||||
|
||||
@ -216,7 +216,7 @@ int OH_Rdb_DestroyConfig(OH_Rdb_ConfigV2 *config);
|
||||
* @return Returns the status code of the execution. Successful execution returns RDB_OK,
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @since 13
|
||||
* @since 14
|
||||
*/
|
||||
int OH_Rdb_SetDatabaseDir(OH_Rdb_ConfigV2 *config, const char *databaseDir);
|
||||
|
||||
@ -229,7 +229,7 @@ int OH_Rdb_SetDatabaseDir(OH_Rdb_ConfigV2 *config, const char *databaseDir);
|
||||
* @return Returns the status code of the execution. Successful execution returns RDB_OK,
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @since 13
|
||||
* @since 14
|
||||
*/
|
||||
int OH_Rdb_SetStoreName(OH_Rdb_ConfigV2 *config, const char *storeName);
|
||||
|
||||
@ -242,7 +242,7 @@ int OH_Rdb_SetStoreName(OH_Rdb_ConfigV2 *config, const char *storeName);
|
||||
* @return Returns the status code of the execution. Successful execution returns RDB_OK,
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @since 13
|
||||
* @since 14
|
||||
*/
|
||||
int OH_Rdb_SetBundleName(OH_Rdb_ConfigV2 *config, const char *bundleName);
|
||||
|
||||
@ -255,7 +255,7 @@ int OH_Rdb_SetBundleName(OH_Rdb_ConfigV2 *config, const char *bundleName);
|
||||
* @return Returns the status code of the execution. Successful execution returns RDB_OK,
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @since 13
|
||||
* @since 14
|
||||
*/
|
||||
int OH_Rdb_SetModuleName(OH_Rdb_ConfigV2 *config, const char *moduleName);
|
||||
|
||||
@ -264,11 +264,11 @@ int OH_Rdb_SetModuleName(OH_Rdb_ConfigV2 *config, const char *moduleName);
|
||||
*
|
||||
* @param config Represents a pointer to {@link OH_Rdb_ConfigV2} instance.
|
||||
* Indicates the configuration of the database related to this RDB store.
|
||||
* @param isEncrypt Indicates whether the database is encrypted.
|
||||
* @param isEncrypted Indicates whether the database is encrypted.
|
||||
* @return Returns the status code of the execution. Successful execution returns RDB_OK,
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @since 13
|
||||
* @since 14
|
||||
*/
|
||||
int OH_Rdb_SetEncrypted(OH_Rdb_ConfigV2 *config, bool isEncrypted);
|
||||
|
||||
@ -281,7 +281,7 @@ int OH_Rdb_SetEncrypted(OH_Rdb_ConfigV2 *config, bool isEncrypted);
|
||||
* @return Returns the status code of the execution. Successful execution returns RDB_OK,
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @since 13
|
||||
* @since 14
|
||||
*/
|
||||
int OH_Rdb_SetSecurityLevel(OH_Rdb_ConfigV2 *config, int securityLevel);
|
||||
|
||||
@ -290,10 +290,11 @@ int OH_Rdb_SetSecurityLevel(OH_Rdb_ConfigV2 *config, int securityLevel);
|
||||
*
|
||||
* @param config Represents a pointer to {@link OH_Rdb_ConfigV2} instance.
|
||||
* Indicates the configuration of the database related to this RDB store
|
||||
* @param area Represents the security area of the database.
|
||||
* @return Returns the status code of the execution. Successful execution returns RDB_OK,
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @since 13
|
||||
* @since 14
|
||||
*/
|
||||
int OH_Rdb_SetArea(OH_Rdb_ConfigV2 *config, int area);
|
||||
|
||||
@ -305,15 +306,15 @@ int OH_Rdb_SetArea(OH_Rdb_ConfigV2 *config, int area);
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* {@link RDB_E_NOT_SUPPORTED} - The error code for not support db types.
|
||||
* @since 13
|
||||
* @since 14
|
||||
*/
|
||||
int OH_Rdb_SetDbType(OH_Rdb_ConfigV2 *config, int dbType);
|
||||
|
||||
/**
|
||||
* @brief Get support db type list
|
||||
* @param numType The output parameter, which is used to recieve the length of the support db type array.
|
||||
* @param typeCount The output parameter, which is used to recieve the length of the support db type array.
|
||||
* @return Return Rdb_DBType array contains supported db type, array length is number of support type
|
||||
* @since 13
|
||||
* @since 14
|
||||
*/
|
||||
const int *OH_Rdb_GetSupportedDbType(int *typeCount);
|
||||
|
||||
@ -380,7 +381,7 @@ OH_Rdb_Store *OH_Rdb_GetOrOpen(const OH_Rdb_Config *config, int *errCode);
|
||||
* If the Config is empty, config.size does not match, or errCode is empty.
|
||||
* Get database path failed.Get RDB Store fail. Nullptr is returned.
|
||||
* @see OH_Rdb_ConfigV2, OH_Rdb_Store.
|
||||
* @since 13
|
||||
* @since 14
|
||||
*/
|
||||
OH_Rdb_Store *OH_Rdb_CreateOrOpen(const OH_Rdb_ConfigV2 *config, int *errCode);
|
||||
|
||||
@ -421,7 +422,7 @@ int OH_Rdb_DeleteStore(const OH_Rdb_Config *config);
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* while failure returns a specific error code. Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see OH_Rdb_ErrCode.
|
||||
* @since 13
|
||||
* @since 14
|
||||
*/
|
||||
int OH_Rdb_DeleteStoreV2(const OH_Rdb_ConfigV2 *config);
|
||||
|
||||
@ -503,14 +504,14 @@ int OH_Rdb_Execute(OH_Rdb_Store *store, const char *sql);
|
||||
* @brief Write operations are performed using the specified transaction represented by the transaction ID
|
||||
*
|
||||
* @param store Represents a pointer to an {@link OH_Rdb_Store} instance.
|
||||
* @param sql Indicates the SQL statement to execute.
|
||||
* @param trxId The transaction ID of the specified transaction, must be greater than 0
|
||||
* @param sql Indicates the SQL statement to execute.
|
||||
* @return Returns the status code of the execution.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* {@link RDB_E_NOT_SUPPORTED} - The error code for not supprt.
|
||||
* @see OH_Rdb_Store.
|
||||
* @since 13
|
||||
* @since 14
|
||||
*/
|
||||
int OH_Rdb_ExecuteByTrxId(OH_Rdb_Store *store, int64_t trxId, const char *sql);
|
||||
|
||||
@ -572,7 +573,7 @@ int OH_Rdb_Commit(OH_Rdb_Store *store);
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* {@link RDB_E_NOT_SUPPORTED} - The error code for not supprt.
|
||||
* @see OH_Rdb_Store.
|
||||
* @since 13
|
||||
* @since 14
|
||||
*/
|
||||
int OH_Rdb_BeginTransWithTrxId(OH_Rdb_Store *store, int64_t *trxId);
|
||||
|
||||
@ -586,7 +587,7 @@ int OH_Rdb_BeginTransWithTrxId(OH_Rdb_Store *store, int64_t *trxId);
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* {@link RDB_E_NOT_SUPPORTED} - The error code for not supprt.
|
||||
* @see OH_Rdb_Store.
|
||||
* @since 13
|
||||
* @since 14
|
||||
*/
|
||||
int OH_Rdb_RollBackByTrxId(OH_Rdb_Store *store, int64_t trxId);
|
||||
|
||||
@ -600,7 +601,7 @@ int OH_Rdb_RollBackByTrxId(OH_Rdb_Store *store, int64_t trxId);
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* {@link RDB_E_NOT_SUPPORTED} - The error code for not supprt.
|
||||
* @see OH_Rdb_Store.
|
||||
* @since 13
|
||||
* @since 14
|
||||
*/
|
||||
int OH_Rdb_CommitByTrxId(OH_Rdb_Store *store, int64_t trxId);
|
||||
|
||||
|
||||
@ -3,58 +3,58 @@
|
||||
{"name":"OH_Rdb_CreateValueObject" },
|
||||
{"name":"OH_Rdb_CreateValuesBucket" },
|
||||
{
|
||||
"first_introduced":"13",
|
||||
"first_introduced":"14",
|
||||
"name":"OH_Rdb_CreateConfig"
|
||||
},
|
||||
{
|
||||
"first_introduced": "13",
|
||||
"first_introduced": "14",
|
||||
"name":"OH_Rdb_SetDatabaseDir"
|
||||
},
|
||||
{
|
||||
"first_introduced": "13",
|
||||
"first_introduced": "14",
|
||||
"name":"OH_Rdb_SetStoreName"
|
||||
},
|
||||
{
|
||||
"first_introduced": "13",
|
||||
"first_introduced": "14",
|
||||
"name":"OH_Rdb_SetBundleName"
|
||||
},
|
||||
{
|
||||
"first_introduced": "13",
|
||||
"first_introduced": "14",
|
||||
"name":"OH_Rdb_SetModuleName"
|
||||
},
|
||||
{
|
||||
"first_introduced": "13",
|
||||
"first_introduced": "14",
|
||||
"name":"OH_Rdb_SetEncrypted"
|
||||
},
|
||||
{
|
||||
"first_introduced": "13",
|
||||
"first_introduced": "14",
|
||||
"name":"OH_Rdb_SetSecurityLevel"
|
||||
},
|
||||
{
|
||||
"first_introduced": "13",
|
||||
"first_introduced": "14",
|
||||
"name":"OH_Rdb_SetArea"
|
||||
},
|
||||
{
|
||||
"first_introduced": "13",
|
||||
"first_introduced": "14",
|
||||
"name":"OH_Rdb_SetDbType"
|
||||
},
|
||||
{
|
||||
"first_introduced": "13",
|
||||
"first_introduced": "14",
|
||||
"name":"OH_Rdb_GetSupportedDbType"
|
||||
},
|
||||
{
|
||||
"first_introduced": "13",
|
||||
"first_introduced": "14",
|
||||
"name":"OH_Rdb_DestroyConfig"
|
||||
},
|
||||
{"name":"OH_Rdb_GetOrOpen" },
|
||||
{
|
||||
"first_introduced": "13",
|
||||
"first_introduced": "14",
|
||||
"name":"OH_Rdb_CreateOrOpen"
|
||||
},
|
||||
{"name":"OH_Rdb_CloseStore" },
|
||||
{"name":"OH_Rdb_DeleteStore" },
|
||||
{
|
||||
"first_introduced": "13",
|
||||
"first_introduced": "14",
|
||||
"name":"OH_Rdb_DeleteStoreV2"
|
||||
},
|
||||
{"name":"OH_Rdb_Insert" },
|
||||
@ -63,7 +63,7 @@
|
||||
{"name":"OH_Rdb_Query" },
|
||||
{"name":"OH_Rdb_Execute" },
|
||||
{
|
||||
"first_introduced": "13",
|
||||
"first_introduced": "14",
|
||||
"name":"OH_Rdb_ExecuteByTrxId"
|
||||
},
|
||||
{"name":"OH_Rdb_ExecuteQuery" },
|
||||
@ -71,15 +71,15 @@
|
||||
{"name":"OH_Rdb_RollBack" },
|
||||
{"name":"OH_Rdb_Commit" },
|
||||
{
|
||||
"first_introduced": "13",
|
||||
"first_introduced": "14",
|
||||
"name":"OH_Rdb_BeginTransWithTrxId"
|
||||
},
|
||||
{
|
||||
"first_introduced": "13",
|
||||
"first_introduced": "14",
|
||||
"name":"OH_Rdb_RollBackByTrxId"
|
||||
},
|
||||
{
|
||||
"first_introduced": "13",
|
||||
"first_introduced": "14",
|
||||
"name":"OH_Rdb_CommitByTrxId"
|
||||
},
|
||||
{"name":"OH_Rdb_Backup" },
|
||||
|
||||
Loading…
Reference in New Issue
Block a user