mirror of
https://gitee.com/openharmony/interface_sdk_c
synced 2024-11-23 06:39:54 +00:00
errorcode
Signed-off-by: 安文韬 <anwentao@huawei.com>
This commit is contained in:
安文韬
parent
051dbe50ac
commit
e44781fe2e
@ -97,6 +97,8 @@ typedef struct Data_Asset Data_Asset;
|
||||
* @param asset Represents a pointer to an {@link Data_Asset} instance.
|
||||
* @param name Indicates the name to set.
|
||||
* @return Returns a specific error code.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see Data_Asset
|
||||
* @since 11
|
||||
@ -109,6 +111,8 @@ int OH_Data_Asset_SetName(Data_Asset *asset, const char *name);
|
||||
* @param asset Represents a pointer to an {@link Data_Asset} instance.
|
||||
* @param uri Indicates the uri to set.
|
||||
* @return Returns a specific error code.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see Data_Asset
|
||||
* @since 11
|
||||
@ -121,6 +125,8 @@ int OH_Data_Asset_SetUri(Data_Asset *asset, const char *uri);
|
||||
* @param asset Represents a pointer to an {@link Data_Asset} instance.
|
||||
* @param path Indicates the path to set.
|
||||
* @return Returns a specific error code.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see Data_Asset
|
||||
* @since 11
|
||||
@ -133,6 +139,8 @@ int OH_Data_Asset_SetPath(Data_Asset *asset, const char *path);
|
||||
* @param asset Represents a pointer to an {@link Data_Asset} instance.
|
||||
* @param createTime Indicates the create time to set.
|
||||
* @return Returns a specific error code.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see Data_Asset
|
||||
* @since 11
|
||||
@ -145,6 +153,8 @@ int OH_Data_Asset_SetCreateTime(Data_Asset *asset, int64_t createTime);
|
||||
* @param asset Represents a pointer to an {@link Data_Asset} instance.
|
||||
* @param modifyTime Indicates the create time to set.
|
||||
* @return Returns a specific error code.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see Data_Asset
|
||||
* @since 11
|
||||
@ -157,6 +167,8 @@ int OH_Data_Asset_SetModifyTime(Data_Asset *asset, int64_t modifyTime);
|
||||
* @param asset Represents a pointer to an {@link Data_Asset} instance.
|
||||
* @param size Indicates the size to set.
|
||||
* @return Returns a specific error code.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see Data_Asset
|
||||
* @since 11
|
||||
@ -169,6 +181,8 @@ int OH_Data_Asset_SetSize(Data_Asset *asset, size_t size);
|
||||
* @param asset Represents a pointer to an {@link Data_Asset} instance.
|
||||
* @param status Indicates the status to set. Specific status can be referenced {@link Data_AssetStatus}.
|
||||
* @return Returns a specific error code.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see Data_Asset, Data_AssetStatus
|
||||
* @since 11
|
||||
@ -183,6 +197,9 @@ int OH_Data_Asset_SetStatus(Data_Asset *asset, Data_AssetStatus status);
|
||||
* and the name of the asset as a char * is written to this variable.
|
||||
* @param length Indicates the length of the name.
|
||||
* @return Returns a specific error code.
|
||||
* {@link RDB_ERR} - Indicates that the function execution exception.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see Data_Asset
|
||||
* @since 11
|
||||
@ -197,6 +214,9 @@ int OH_Data_Asset_GetName(Data_Asset *asset, char *name, size_t *length);
|
||||
* and the uri of the asset as a char * is written to this variable.
|
||||
* @param length Indicates the length of the uri.
|
||||
* @return Returns a specific error code.
|
||||
* {@link RDB_ERR} - Indicates that the function execution exception.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see Data_Asset
|
||||
* @since 11
|
||||
@ -211,6 +231,9 @@ int OH_Data_Asset_GetUri(Data_Asset *asset, char *uri, size_t *length);
|
||||
* and the path of the asset as a char * is written to this variable.
|
||||
* @param length Indicates the length of the path.
|
||||
* @return Returns a specific error code.
|
||||
* {@link RDB_ERR} - Indicates that the function execution exception.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see Data_Asset
|
||||
* @since 11
|
||||
@ -224,6 +247,9 @@ int OH_Data_Asset_GetPath(Data_Asset *asset, char *path, size_t *length);
|
||||
* @param createTime This parameter is the output parameter,
|
||||
* and the create time of the asset as a int64_t is written to this variable.
|
||||
* @return Returns a specific error code.
|
||||
* {@link RDB_ERR} - Indicates that the function execution exception.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see Data_Asset
|
||||
* @since 11
|
||||
@ -237,6 +263,9 @@ int OH_Data_Asset_GetCreateTime(Data_Asset *asset, int64_t *createTime);
|
||||
* @param modifyTime This parameter is the output parameter,
|
||||
* and the create time of the asset as a int64_t is written to this variable.
|
||||
* @return Returns a specific error code.
|
||||
* {@link RDB_ERR} - Indicates that the function execution exception.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see Data_Asset
|
||||
* @since 11
|
||||
@ -250,6 +279,9 @@ int OH_Data_Asset_GetModifyTime(Data_Asset *asset, int64_t *modifyTime);
|
||||
* @param size This parameter is the output parameter,
|
||||
* and the size of the asset as a size_t is written to this variable.
|
||||
* @return Returns a specific error code.
|
||||
* {@link RDB_ERR} - Indicates that the function execution exception.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see Data_Asset
|
||||
* @since 11
|
||||
@ -263,6 +295,8 @@ int OH_Data_Asset_GetSize(Data_Asset *asset, size_t *size);
|
||||
* @param status This parameter is the output parameter,
|
||||
* and the size of the status as a {@link Data_AssetStatus} is written to this variable.
|
||||
* @return Returns a specific error code.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see Data_Asset Data_AssetStatus.
|
||||
* @since 11
|
||||
@ -294,8 +328,8 @@ int OH_Data_Asset_DestroyOne(Data_Asset *asset);
|
||||
* @brief Creates {@link Data_Asset} instances of given number.
|
||||
*
|
||||
* @param count Represents the count of {@link Data_Asset} to create.
|
||||
* @return If the creation is successful, a pointer to the instance of the @link Data_Asset} structure is returned,
|
||||
* otherwise NULL is returned.
|
||||
* @return If the creation is successful, a pointer to the instance of the {@link Data_Asset} structure is returned.
|
||||
* If the creation is unsuccessful, NULL is returned.
|
||||
* @see Data_Asset.
|
||||
* @since 11
|
||||
*/
|
||||
@ -315,4 +349,4 @@ int OH_Data_Asset_DestroyMultiple(Data_Asset **assets, uint32_t count);
|
||||
#ifdef __cplusplus
|
||||
};
|
||||
#endif
|
||||
#endif //DATA_ASSET_H
|
||||
#endif // DATA_ASSET_H
|
||||
|
||||
@ -147,6 +147,8 @@ typedef struct OH_VBucket {
|
||||
* @param field Indicates the name of the column.
|
||||
* @param value Indicates the const {@link Data_Asset} * value.
|
||||
* @return Returns the status code of the execution.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @see OH_VBucket.
|
||||
* @since 11
|
||||
*/
|
||||
@ -160,6 +162,8 @@ int OH_VBucket_PutAsset(OH_VBucket *bucket, const char *field, Data_Asset *value
|
||||
* @param value Indicates the {@link Data_Asset} value of given count.
|
||||
* @param count Indicates the count of value.
|
||||
* @return Returns the status code of the execution.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @see OH_VBucket.
|
||||
* @since 11
|
||||
*/
|
||||
|
||||
@ -174,8 +174,8 @@ OH_VBucket *OH_Rdb_CreateValuesBucket();
|
||||
* @brief Creates an {@link OH_Predicates} instance.
|
||||
*
|
||||
* @param table Indicates the table name.
|
||||
* @return If the creation is successful, a pointer to the instance of the @link OH_Predicates} structure is returned,
|
||||
* otherwise NULL is returned.
|
||||
* @return If the creation is successful, a pointer to the instance of the @link OH_Predicates} structure is returned.
|
||||
* If the table name is nullptr, Nullptr is returned.
|
||||
* @see OH_Predicates.
|
||||
* @since 10
|
||||
*/
|
||||
@ -191,8 +191,9 @@ OH_Predicates *OH_Rdb_CreatePredicates(const char *table);
|
||||
* Indicates the configuration of the database related to this RDB store.
|
||||
* @param errCode This parameter is the output parameter,
|
||||
* and the execution status of a function is written to this variable.
|
||||
* @return If the creation is successful, a pointer to the instance of the @link OH_Rdb_Store} structure is returned,
|
||||
* otherwise NULL is returned.
|
||||
* @return If the creation is successful, a pointer to the instance of the @link OH_Rdb_Store} structure is returned.
|
||||
* 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_Config, OH_Rdb_Store.
|
||||
* @since 10
|
||||
*/
|
||||
@ -203,6 +204,8 @@ OH_Rdb_Store *OH_Rdb_GetOrOpen(const OH_Rdb_Config *config, int *errCode);
|
||||
*
|
||||
* @param store Represents a pointer to an {@link OH_Rdb_Store} instance.
|
||||
* @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.
|
||||
* while failure returns a specific error code. Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see OH_Rdb_Store, OH_Rdb_ErrCode.
|
||||
* @since 10
|
||||
@ -215,6 +218,8 @@ int OH_Rdb_CloseStore(OH_Rdb_Store *store);
|
||||
* @param config Represents a pointer to an {@link OH_Rdb_Config} instance.
|
||||
* Indicates the configuration of the database related to this RDB store.
|
||||
* @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.
|
||||
* while failure returns a specific error code. Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see OH_Rdb_ErrCode.
|
||||
* @since 10
|
||||
@ -228,6 +233,8 @@ int OH_Rdb_DeleteStore(const OH_Rdb_Config *config);
|
||||
* @param table Indicates the target table.
|
||||
* @param valuesBucket Indicates the row of data {@link OH_VBucket} to be inserted into the table.
|
||||
* @return Returns the rowId if success, returns a specific error code.
|
||||
* {@link RDB_ERR} - Indicates that the function execution exception.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see OH_Rdb_Store, OH_VBucket, OH_Rdb_ErrCode.
|
||||
* @since 10
|
||||
@ -242,6 +249,8 @@ int OH_Rdb_Insert(OH_Rdb_Store *store, const char *table, OH_VBucket *valuesBuck
|
||||
* @param predicates Represents a pointer to an {@link OH_Predicates} instance.
|
||||
* Indicates the specified update condition.
|
||||
* @return Returns the number of rows changed if success, otherwise, returns a specific error code.
|
||||
* {@link RDB_ERR} - Indicates that the function execution exception.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see OH_Rdb_Store, OH_Bucket, OH_Predicates, OH_Rdb_ErrCode.
|
||||
* @since 10
|
||||
@ -255,6 +264,8 @@ int OH_Rdb_Update(OH_Rdb_Store *store, OH_VBucket *valuesBucket, OH_Predicates *
|
||||
* @param predicates Represents a pointer to an {@link OH_Predicates} instance.
|
||||
* Indicates the specified delete condition.
|
||||
* @return Returns the number of rows changed if success, otherwise, returns a specific error code.
|
||||
* {@link RDB_ERR} - Indicates that the function execution exception.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* Specific error codes can be referenced {@link OH_Rdb_ErrCode}.
|
||||
* @see OH_Rdb_Store, OH_Predicates, OH_Rdb_ErrCode.
|
||||
* @since 10
|
||||
@ -269,8 +280,8 @@ int OH_Rdb_Delete(OH_Rdb_Store *store, OH_Predicates *predicates);
|
||||
* Indicates the specified query condition.
|
||||
* @param columnNames Indicates the columns to query. If the value is empty array, the query applies to all columns.
|
||||
* @param length Indicates the length of columnNames.
|
||||
* @return If the query is successful, a pointer to the instance of the @link OH_Cursor} structure is returned,
|
||||
* otherwise NULL is returned.
|
||||
* @return If the query is successful, a pointer to the instance of the @link OH_Cursor} structure is returned.
|
||||
* If Get store failed or resultSet is nullptr, nullptr is returned.
|
||||
* @see OH_Rdb_Store, OH_Predicates, OH_Cursor.
|
||||
* @since 10
|
||||
*/
|
||||
@ -282,6 +293,8 @@ OH_Cursor *OH_Rdb_Query(OH_Rdb_Store *store, OH_Predicates *predicates, const ch
|
||||
* @param store Represents a pointer to an {@link OH_Rdb_Store} instance.
|
||||
* @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.
|
||||
* @see OH_Rdb_Store.
|
||||
* @since 10
|
||||
*/
|
||||
@ -292,8 +305,8 @@ int OH_Rdb_Execute(OH_Rdb_Store *store, const char *sql);
|
||||
*
|
||||
* @param store Represents a pointer to an {@link OH_Rdb_Store} instance.
|
||||
* @param sql Indicates the SQL statement to execute.
|
||||
* @return If the query is successful, a pointer to the instance of the @link OH_Cursor} structure is returned,
|
||||
* otherwise NULL is returned.
|
||||
* @return If the query is successful, a pointer to the instance of the @link OH_Cursor} structure is returned.
|
||||
* If Get store failed,sql is nullptr or resultSet is nullptr, nullptr is returned.
|
||||
* @see OH_Rdb_Store.
|
||||
* @since 10
|
||||
*/
|
||||
@ -304,6 +317,8 @@ OH_Cursor *OH_Rdb_ExecuteQuery(OH_Rdb_Store *store, const char *sql);
|
||||
*
|
||||
* @param store Represents a pointer to an {@link OH_Rdb_Store} instance.
|
||||
* @return Returns the status code of the execution.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @see OH_Rdb_Store.
|
||||
* @since 10
|
||||
*/
|
||||
@ -314,6 +329,8 @@ int OH_Rdb_BeginTransaction(OH_Rdb_Store *store);
|
||||
*
|
||||
* @param store Represents a pointer to an {@link OH_Rdb_Store} instance.
|
||||
* @return Returns the status code of the execution.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @see OH_Rdb_Store.
|
||||
* @since 10
|
||||
*/
|
||||
@ -324,6 +341,8 @@ int OH_Rdb_RollBack(OH_Rdb_Store *store);
|
||||
*
|
||||
* @param store Represents a pointer to an {@link OH_Rdb_Store} instance.
|
||||
* @return Returns the status code of the execution.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @see OH_Rdb_Store.
|
||||
* @since 10
|
||||
*/
|
||||
@ -335,6 +354,8 @@ int OH_Rdb_Commit(OH_Rdb_Store *store);
|
||||
* @param store Represents a pointer to an {@link OH_Rdb_Store} instance.
|
||||
* @param databasePath Indicates the database file path.
|
||||
* @return Returns the status code of the execution.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @see OH_Rdb_Store.
|
||||
* @since 10
|
||||
*/
|
||||
@ -346,6 +367,8 @@ int OH_Rdb_Backup(OH_Rdb_Store *store, const char *databasePath);
|
||||
* @param store Represents a pointer to an {@link OH_Rdb_Store} instance.
|
||||
* @param databasePath Indicates the database file path.
|
||||
* @return Returns the status code of the execution.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @see OH_Rdb_Store.
|
||||
* @since 10
|
||||
*/
|
||||
@ -357,6 +380,8 @@ int OH_Rdb_Restore(OH_Rdb_Store *store, const char *databasePath);
|
||||
* @param store Represents a pointer to an {@link OH_Rdb_Store} instance.
|
||||
* @param version Indicates the version number.
|
||||
* @return Returns the status code of the execution.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @see OH_Rdb_Store.
|
||||
* @since 10
|
||||
*/
|
||||
@ -368,6 +393,8 @@ int OH_Rdb_GetVersion(OH_Rdb_Store *store, int *version);
|
||||
* @param store Represents a pointer to an {@link OH_Rdb_Store} instance.
|
||||
* @param version Indicates the version number.
|
||||
* @return Returns the status code of the execution.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @see OH_Rdb_Store.
|
||||
* @since 10
|
||||
*/
|
||||
@ -416,6 +443,8 @@ typedef struct Rdb_DistributedConfig {
|
||||
* @param type Indicates the distributed type {@link Rdb_DistributedType}.
|
||||
* @param config Indicates the distributed config of the tables. For details, see {@link Rdb_DistributedConfig}.
|
||||
* @return Returns the status code of the execution. See {@link OH_Rdb_ErrCode}.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @see OH_Rdb_Store.
|
||||
* @see Rdb_DistributedConfig.
|
||||
* @since 11
|
||||
@ -433,6 +462,7 @@ int OH_Rdb_SetDistributedTables(OH_Rdb_Store *store, const char *tables[], uint3
|
||||
* @param values Indicates the primary keys of the rows to check.
|
||||
* If the table has no primary key , please pass in the row-ids of the rows to check.
|
||||
* @return If the operation is successful, a pointer to the instance of the @link OH_Cursor} structure is returned.
|
||||
* If Get store failed, NULL is returned.
|
||||
* There are two columns, "data_key" and "timestamp". Otherwise NULL is returned.
|
||||
* @see OH_Rdb_Store.
|
||||
* @see OH_VObject.
|
||||
@ -627,6 +657,8 @@ typedef struct Rdb_DataObserver {
|
||||
* in the local database.
|
||||
* @param observer The {@link Rdb_DataObserver} of change events in the database.
|
||||
* @return Returns the status code of the execution. See {@link OH_Rdb_ErrCode}.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @see OH_Rdb_Store.
|
||||
* @see Rdb_DataObserver.
|
||||
* @since 11
|
||||
@ -641,6 +673,8 @@ int OH_Rdb_Subscribe(OH_Rdb_Store *store, Rdb_SubscribeType type, const Rdb_Data
|
||||
* @param observer The {@link Rdb_DataObserver} of change events in the database.
|
||||
* If this is nullptr, remove all observers of the type.
|
||||
* @return Returns the status code of the execution. See {@link OH_Rdb_ErrCode}.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @see OH_Rdb_Store.
|
||||
* @see Rdb_DataObserver.
|
||||
* @since 11
|
||||
@ -821,7 +855,7 @@ typedef struct Rdb_ProgressDetails {
|
||||
* @param progress Represents a pointer to an {@link Rdb_ProgressDetails} instance.
|
||||
* @param version Indicates the version of current {@link Rdb_ProgressDetails}.
|
||||
* @return If the operation is successful, a pointer to the instance of the {@link Rdb_TableDetails}
|
||||
* structure is returned. Otherwise NULL is returned.
|
||||
* structure is returned.If get details is failed,nullptr is returned.
|
||||
* @see Rdb_ProgressDetails
|
||||
* @see Rdb_TableDetails
|
||||
* @since 11
|
||||
@ -872,6 +906,8 @@ typedef struct Rdb_ProgressObserver {
|
||||
* @param count The count of tables to sync. If value equals 0, sync all tables of the store.
|
||||
* @param observer The {@link Rdb_ProgressObserver} of cloud sync progress.
|
||||
* @return Returns the status code of the execution. See {@link OH_Rdb_ErrCode}.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @see OH_Rdb_Store.
|
||||
* @see Rdb_ProgressObserver.
|
||||
* @since 11
|
||||
@ -887,6 +923,8 @@ int OH_Rdb_CloudSync(OH_Rdb_Store *store, Rdb_SyncMode mode, const char *tables[
|
||||
* @param observer The {@link Rdb_ProgressObserver} for the automatic synchornizaiton progress.
|
||||
* Indicates the callback invoked to return the automatic synchronization progress.
|
||||
* @return Returns the status code of the execution. See {@link OH_Rdb_ErrCode}.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @see OH_Rdb_Store.
|
||||
* @see Rdb_ProgressObserver.
|
||||
* @since 11
|
||||
@ -900,6 +938,8 @@ int OH_Rdb_SubscribeAutoSyncProgress(OH_Rdb_Store *store, const Rdb_ProgressObse
|
||||
* @param observer Indicates the {@link Rdb_ProgressObserver} callback for the automatic synchornizaiton progress.
|
||||
* If it is a null pointer, all callbacks for the automatic synchornizaiton progress will be unregistered.
|
||||
* @return Returns the status code of the execution. See {@link OH_Rdb_ErrCode}.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @see OH_Rdb_Store.
|
||||
* @see Rdb_ProgressObserver.
|
||||
* @since 11
|
||||
@ -913,6 +953,8 @@ int OH_Rdb_UnsubscribeAutoSyncProgress(OH_Rdb_Store *store, const Rdb_ProgressOb
|
||||
* @param predicates Represents a pointer to an {@link OH_Predicates} instance.
|
||||
* Indicates the specified lock condition.
|
||||
* @return Returns the status code of the execution. See {@link OH_Rdb_ErrCode}.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @see OH_Rdb_Store, OH_Predicates, OH_Rdb_ErrCode.
|
||||
* @since 12
|
||||
*/
|
||||
@ -925,6 +967,8 @@ int OH_Rdb_LockRow(OH_Rdb_Store *store, OH_Predicates *predicates);
|
||||
* @param predicates Represents a pointer to an {@link OH_Predicates} instance.
|
||||
* Indicates the specified unlock condition.
|
||||
* @return Returns the status code of the execution. See {@link OH_Rdb_ErrCode}.
|
||||
* {@link RDB_OK} - success.
|
||||
* {@link RDB_E_INVALID_ARGS} - The error code for common invalid args.
|
||||
* @see OH_Rdb_Store, OH_Predicates, OH_Rdb_ErrCode.
|
||||
* @since 12
|
||||
*/
|
||||
@ -938,8 +982,8 @@ int OH_Rdb_UnlockRow(OH_Rdb_Store *store, OH_Predicates *predicates);
|
||||
* Indicates the specified query condition.
|
||||
* @param columnNames Indicates the columns to query. If the value is empty array, the query applies to all columns.
|
||||
* @param length Indicates the length of columnNames.
|
||||
* @return If the query is successful, a pointer to the instance of the @link OH_Cursor} structure is returned,
|
||||
* otherwise NULL is returned.
|
||||
* @return If the query is successful, a pointer to the instance of the @link OH_Cursor} structure is returned.
|
||||
* If Get store failed or resultSet is nullptr, nullptr is returned.
|
||||
* @see OH_Rdb_Store, OH_Predicates, OH_Cursor.
|
||||
* @since 12
|
||||
*/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user