From 584dabfa8be115a25ec1b14e9c8a7d7071c9ccd6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=83=A1=E8=8A=B7=E7=8F=8A?= Date: Wed, 18 Jun 2025 11:15:32 +0800 Subject: [PATCH 1/2] update docs --- .../reference/apis-arkdata/_o_h___cursor.md | 2 ++ .../reference/apis-arkdata/_o_h___predicates.md | 1 + .../reference/apis-arkdata/_o_h___rdb___config.md | 2 ++ .../reference/apis-arkdata/_o_h___rdb___store.md | 2 ++ .../reference/apis-arkdata/_o_h___v_bucket.md | 2 ++ .../reference/apis-arkdata/_o_h___v_object.md | 2 ++ .../reference/apis-arkdata/_rdb___change_info.md | 2 ++ .../reference/apis-arkdata/_rdb___data_observer.md | 8 +++++--- .../reference/apis-arkdata/_rdb___distributed_config.md | 2 ++ .../reference/apis-arkdata/_rdb___key_info.md | 1 + .../reference/apis-arkdata/_rdb___progress_details.md | 2 ++ .../reference/apis-arkdata/_rdb___progress_observer.md | 7 ++++--- .../reference/apis-arkdata/_rdb___statistic.md | 1 + .../reference/apis-arkdata/_rdb___table_details.md | 2 ++ .../union_rdb___key_info_1_1_rdb___key_data.md | 2 ++ .../apis-arkdata/union_rdb___subscribe_callback.md | 7 ++++--- 16 files changed, 36 insertions(+), 9 deletions(-) diff --git a/en/application-dev/reference/apis-arkdata/_o_h___cursor.md b/en/application-dev/reference/apis-arkdata/_o_h___cursor.md index 619054b5a03..9dc20c8ccf7 100644 --- a/en/application-dev/reference/apis-arkdata/_o_h___cursor.md +++ b/en/application-dev/reference/apis-arkdata/_o_h___cursor.md @@ -10,6 +10,8 @@ Provides APIs to access the result set obtained by querying the RDB store. **Related module**: [RDB](_r_d_b.md) +**Header file**: [oh_cursor.h](capi-oh-cursor-h.md) + ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_o_h___predicates.md b/en/application-dev/reference/apis-arkdata/_o_h___predicates.md index c0fced7c2ce..f5aa43176fc 100644 --- a/en/application-dev/reference/apis-arkdata/_o_h___predicates.md +++ b/en/application-dev/reference/apis-arkdata/_o_h___predicates.md @@ -9,6 +9,7 @@ Defines the predicates for RDB stores. **Related module**: [RDB](_r_d_b.md) +**Header file**: [oh_predicates.h](capi-oh-predicates-h.md) ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_o_h___rdb___config.md b/en/application-dev/reference/apis-arkdata/_o_h___rdb___config.md index c77f811fd4e..46d38ca2e18 100644 --- a/en/application-dev/reference/apis-arkdata/_o_h___rdb___config.md +++ b/en/application-dev/reference/apis-arkdata/_o_h___rdb___config.md @@ -9,6 +9,8 @@ Defines the RDB store configuration. **Related module**: [RDB](_r_d_b.md) +**Header file**: [relational_store.h](capi-relational-store-h.md) + ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_o_h___rdb___store.md b/en/application-dev/reference/apis-arkdata/_o_h___rdb___store.md index 40f9f3c89ba..84976037a14 100644 --- a/en/application-dev/reference/apis-arkdata/_o_h___rdb___store.md +++ b/en/application-dev/reference/apis-arkdata/_o_h___rdb___store.md @@ -9,6 +9,8 @@ Defines the RDB store type. **Related module**: [RDB](_r_d_b.md) +**Header file**: [relational_store.h](capi-relational-store-h.md) + ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_o_h___v_bucket.md b/en/application-dev/reference/apis-arkdata/_o_h___v_bucket.md index 7acbfbc43a5..6bb3a70a20c 100644 --- a/en/application-dev/reference/apis-arkdata/_o_h___v_bucket.md +++ b/en/application-dev/reference/apis-arkdata/_o_h___v_bucket.md @@ -9,6 +9,7 @@ Defines the types of the key and value in a KV pair. **Related module**: [RDB](_r_d_b.md) +**Header file**: [oh_values_bucket.h](capi-oh-values-bucket-h.md) ## Summary @@ -26,3 +27,4 @@ Defines the types of the key and value in a KV pair. | [putNull](_r_d_b.md#putnull) | Puts a null value into the **OH_VBucket** object in the given column.| | [clear](_r_d_b.md#clear-22) | Clears an **OH_VBucket** object.| | [destroy](_r_d_b.md#destroy-34) | Destroys an **OH_VBucket** object and reclaims the memory occupied.| + diff --git a/en/application-dev/reference/apis-arkdata/_o_h___v_object.md b/en/application-dev/reference/apis-arkdata/_o_h___v_object.md index ef909e29993..c7d1907ff69 100644 --- a/en/application-dev/reference/apis-arkdata/_o_h___v_object.md +++ b/en/application-dev/reference/apis-arkdata/_o_h___v_object.md @@ -9,6 +9,8 @@ Defines the allowed data field types. **Related module**: [RDB](_r_d_b.md) +**Header file**: [oh_value_object.h](capi-oh-value-object-h.md) + ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_rdb___change_info.md b/en/application-dev/reference/apis-arkdata/_rdb___change_info.md index 2d41b6ec9c6..d754cc8eb69 100644 --- a/en/application-dev/reference/apis-arkdata/_rdb___change_info.md +++ b/en/application-dev/reference/apis-arkdata/_rdb___change_info.md @@ -9,6 +9,8 @@ Defines a struct for the details about the device-cloud sync process. **Related module**: [RDB](_r_d_b.md) +**Header file**: [relational_store.h](capi-relational-store-h.md) + ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_rdb___data_observer.md b/en/application-dev/reference/apis-arkdata/_rdb___data_observer.md index ce3bfcccf1a..16fdcce12da 100644 --- a/en/application-dev/reference/apis-arkdata/_rdb___data_observer.md +++ b/en/application-dev/reference/apis-arkdata/_rdb___data_observer.md @@ -9,13 +9,15 @@ Defines the data observer. **Related module**: [RDB](_r_d_b.md) +**Header file**: [relational_store.h](capi-relational-store-h.md) + ## Summary ### Member Variables -| Name| Description| +| Name| Description| | -------- | -------- | -| [context](_r_d_b.md#context-12) | Context of the data observer.| -| [callback](_r_d_b.md#callback-12) | Callback used to return the data observed.| +| [context](_r_d_b.md#context-12) | Context of the data observer.| +| [callback](_r_d_b.md#callback-12) | Callback used to return the data observed.| diff --git a/en/application-dev/reference/apis-arkdata/_rdb___distributed_config.md b/en/application-dev/reference/apis-arkdata/_rdb___distributed_config.md index d84b0e4bfd1..2b37af5ad57 100644 --- a/en/application-dev/reference/apis-arkdata/_rdb___distributed_config.md +++ b/en/application-dev/reference/apis-arkdata/_rdb___distributed_config.md @@ -9,6 +9,8 @@ Defines a struct for distributed configuration of a table. **Related module**: [RDB](_r_d_b.md) +**Header file**: [relational_store.h](capi-relational-store-h.md) + ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_rdb___key_info.md b/en/application-dev/reference/apis-arkdata/_rdb___key_info.md index b06896b2820..662347e898f 100644 --- a/en/application-dev/reference/apis-arkdata/_rdb___key_info.md +++ b/en/application-dev/reference/apis-arkdata/_rdb___key_info.md @@ -9,6 +9,7 @@ Defines a struct for the primary key or row number of the row that changes. **Related module**: [RDB](_r_d_b.md) +**Header file**: [relational_store.h](capi-relational-store-h.md) ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_rdb___progress_details.md b/en/application-dev/reference/apis-arkdata/_rdb___progress_details.md index 90f9b958005..802ffe82af5 100644 --- a/en/application-dev/reference/apis-arkdata/_rdb___progress_details.md +++ b/en/application-dev/reference/apis-arkdata/_rdb___progress_details.md @@ -9,6 +9,8 @@ Defines a struct for statistics of the overall device-cloud sync (upload and dow **Related module**: [RDB](_r_d_b.md) +**Header file**: [relational_store.h](capi-relational-store-h.md) + ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_rdb___progress_observer.md b/en/application-dev/reference/apis-arkdata/_rdb___progress_observer.md index 8e2558d191c..e1b06501165 100644 --- a/en/application-dev/reference/apis-arkdata/_rdb___progress_observer.md +++ b/en/application-dev/reference/apis-arkdata/_rdb___progress_observer.md @@ -9,13 +9,14 @@ Defines the observer for the device-cloud sync progress. **Related module**: [RDB](_r_d_b.md) +**Header file**: [relational_store.h](capi-relational-store-h.md) ## Summary ### Member Variables -| Name| Description| +| Name| Description| | -------- | -------- | -| [context](_r_d_b.md#context-22) | Context of the device-cloud sync progress observer.| -| [callback](_r_d_b.md#callback-22) | Callback used to return the device-cloud sync progress.| +| [context](_r_d_b.md#context-22) | Context of the device-cloud sync progress observer.| +| [callback](_r_d_b.md#callback-22) | Callback used to return the device-cloud sync progress.| diff --git a/en/application-dev/reference/apis-arkdata/_rdb___statistic.md b/en/application-dev/reference/apis-arkdata/_rdb___statistic.md index 85e60354617..276a9e957b3 100644 --- a/en/application-dev/reference/apis-arkdata/_rdb___statistic.md +++ b/en/application-dev/reference/apis-arkdata/_rdb___statistic.md @@ -9,6 +9,7 @@ Defines a struct for the device-cloud sync statistics of a database table. **Related module**: [RDB](_r_d_b.md) +**Header file**: [relational_store.h](capi-relational-store-h.md) ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_rdb___table_details.md b/en/application-dev/reference/apis-arkdata/_rdb___table_details.md index 3509efe1fe4..62b9e04fc75 100644 --- a/en/application-dev/reference/apis-arkdata/_rdb___table_details.md +++ b/en/application-dev/reference/apis-arkdata/_rdb___table_details.md @@ -9,6 +9,8 @@ Defines a struct for statistics of device-cloud upload and download tasks of a d **Related module**: [RDB](_r_d_b.md) +**Header file**: [relational_store.h](capi-relational-store-h.md) + ## Summary diff --git a/en/application-dev/reference/apis-arkdata/union_rdb___key_info_1_1_rdb___key_data.md b/en/application-dev/reference/apis-arkdata/union_rdb___key_info_1_1_rdb___key_data.md index 27847d42c4b..5defb3f1147 100644 --- a/en/application-dev/reference/apis-arkdata/union_rdb___key_info_1_1_rdb___key_data.md +++ b/en/application-dev/reference/apis-arkdata/union_rdb___key_info_1_1_rdb___key_data.md @@ -9,6 +9,8 @@ Holds the changed data. **Related module**: [RDB](_r_d_b.md) +**Header file**: [relational_store.h](capi-relational-store-h.md) + ## Summary diff --git a/en/application-dev/reference/apis-arkdata/union_rdb___subscribe_callback.md b/en/application-dev/reference/apis-arkdata/union_rdb___subscribe_callback.md index 4b04a80f20e..9a1294434f4 100644 --- a/en/application-dev/reference/apis-arkdata/union_rdb___subscribe_callback.md +++ b/en/application-dev/reference/apis-arkdata/union_rdb___subscribe_callback.md @@ -9,13 +9,14 @@ Defines the callback used to return the subscribed event. **Related module**: [RDB](_r_d_b.md) +**Header file**: [relational_store.h](capi-relational-store-h.md) ## Summary ### Member Variables -| Name| Description| +| Name| Description| | -------- | -------- | -| [detailsObserver](_r_d_b.md#detailsobserver) | Callback used to return the details about the device-cloud data change.| -| [briefObserver](_r_d_b.md#briefobserver) | Callback used to return the device-cloud data change event.| +| [detailsObserver](_r_d_b.md#detailsobserver) | Callback used to return the details about the device-cloud data change.| +| [briefObserver](_r_d_b.md#briefobserver) | Callback used to return the device-cloud data change event. | -- Gitee From a7dedf9cf576f009ea9a58990802c95f7be880a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=83=A1=E8=8A=B7=E7=8F=8A?= Date: Thu, 26 Jun 2025 09:39:35 +0800 Subject: [PATCH 2/2] update docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 胡芷珊 --- .../usb/usbSerial/usbSerial-overview.md | 4 +- .../database/data-persistence-by-rdb-store.md | 2 +- .../database/uniform-data-structure.md | 2 +- en/application-dev/quick-start/in-app-hsp.md | 2 +- .../quick-start/module-configuration-file.md | 4 +- .../reference/apis-arkdata/_o_h___cursor.md | 2 - .../apis-arkdata/_o_h___predicates.md | 2 - .../apis-arkdata/_o_h___rdb___config.md | 2 - .../apis-arkdata/_o_h___rdb___store.md | 2 - .../reference/apis-arkdata/_o_h___v_bucket.md | 2 - .../reference/apis-arkdata/_o_h___v_object.md | 2 - .../reference/apis-arkdata/_r_d_b.md | 194 +++++++++--------- .../apis-arkdata/_rdb___change_info.md | 2 - .../apis-arkdata/_rdb___data_observer.md | 2 - .../apis-arkdata/_rdb___distributed_config.md | 2 - .../reference/apis-arkdata/_rdb___key_info.md | 2 - .../apis-arkdata/_rdb___progress_details.md | 2 - .../apis-arkdata/_rdb___progress_observer.md | 2 - .../apis-arkdata/_rdb___statistic.md | 2 - .../apis-arkdata/_rdb___table_details.md | 2 - .../apis-arkdata/js-apis-data-commonType.md | 2 +- .../apis-arkdata/js-apis-data-preferences.md | 2 +- .../js-apis-data-sendablePreferences.md | 2 +- .../apis-arkdata/oh__predicates_8h.md | 2 +- ...union_rdb___key_info_1_1_rdb___key_data.md | 2 - .../union_rdb___subscribe_callback.md | 2 - .../oh__pasteboard_8h.md | 2 +- 27 files changed, 108 insertions(+), 142 deletions(-) diff --git a/en/application-dev/basic-services/usb/usbSerial/usbSerial-overview.md b/en/application-dev/basic-services/usb/usbSerial/usbSerial-overview.md index 8b93123b3a2..63903f19d4e 100644 --- a/en/application-dev/basic-services/usb/usbSerial/usbSerial-overview.md +++ b/en/application-dev/basic-services/usb/usbSerial/usbSerial-overview.md @@ -56,7 +56,5 @@ The USB serial port service consists of two phases: ### Environment Setup - Install [DevEco Studio](https://developer.huawei.com/consumer/cn/download/deveco-studio) 4.1 or later on the PC. -- Update the public-SDK to API version 18 or later. For details, see [OpenHarmony SDK Upgrade Assistant](../../../tools/openharmony_sdk_upgrade_assistant.md). +- Update the public-SDK to API version 18 or later. - Prepare a USB-to-serial cable. Connect the USB port and the serial port of the cable to that of the OpenHarmony device. - - \ No newline at end of file diff --git a/en/application-dev/database/data-persistence-by-rdb-store.md b/en/application-dev/database/data-persistence-by-rdb-store.md index 6c868be1b93..212ed2642c9 100644 --- a/en/application-dev/database/data-persistence-by-rdb-store.md +++ b/en/application-dev/database/data-persistence-by-rdb-store.md @@ -384,7 +384,7 @@ If error 14800011 is thrown, you need to rebuild the database and restore data t } ``` -5. Back up the database in the same directory.
Two backup modes are available: manual backup and automatic backup (available only for system applications). For details, see [Backing Up an RDB Store](data-backup-and-restore.md#backing-up-an-rdb store). +5. Back up the database in the same directory.
Two backup modes are available: manual backup and automatic backup (available only for system applications). For details, see [Backing Up an RDB Store](data-backup-and-restore.md#backing-up-an-rdb-store). Example: Perform manual backup of an RDB store. diff --git a/en/application-dev/database/uniform-data-structure.md b/en/application-dev/database/uniform-data-structure.md index 3534ea4d32e..196c3cbb7a5 100644 --- a/en/application-dev/database/uniform-data-structure.md +++ b/en/application-dev/database/uniform-data-structure.md @@ -5,7 +5,7 @@ Uniform data structs are provided to define data of common [uniform data types](../reference/apis-arkdata/js-apis-data-uniformTypeDescriptor.md#uniformdatatype). For example, the data struct for the system-defined home screen icon (the uniform data type is **openharmony.app-item**) is provided to help you easily define the data. -Applications can directly use the uniform data structs in certain scenarios. For example, in the drag-and-drop operation across applications, you can write the data (encapsulated in a uniform struct) to be dragged to [DragEvent](../reference/apis-arkui/arkui-ts/ts-universal-events-drag-drop.md#dragevent). The target application (application requesting the data) reads the data from **DragEvent** and parses the data in the uniform data struct. Using uniform data structs for data interaction between applications effectively reduces the development workload in your app experience. +Applications can directly use the uniform data structs in certain scenarios. For example, in the drag-and-drop operation across applications, you can write the data (encapsulated in a uniform struct) to be dragged to [DragEvent](../reference/apis-arkui/arkui-ts/ts-universal-events-drag-drop.md#dragevent7). The target application (application requesting the data) reads the data from **DragEvent** and parses the data in the uniform data struct. Using uniform data structs for data interaction between applications effectively reduces the development workload in your app experience. ## Uniform Data Structs diff --git a/en/application-dev/quick-start/in-app-hsp.md b/en/application-dev/quick-start/in-app-hsp.md index cdee2a211d1..a2be9439690 100644 --- a/en/application-dev/quick-start/in-app-hsp.md +++ b/en/application-dev/quick-start/in-app-hsp.md @@ -120,7 +120,7 @@ export { nativeMulti } from './src/main/ets/utils/nativeTest'; ### Accessing Resources in an HSP Through $r More often than not, you may need to use resources, such as strings and images, in components. For components in an HSP, such resources are typically placed in the HSP package, rather than in the package where the HSP is invoked, for the purpose of complying with the principle of high cohesion and low coupling. -In a project, application resources are referenced in the $r/$rawfile format. You can use **$r**/**$rawfile** to access resources in the **resources** directory of the current module. For example, you can use **$r("app.media.example")** to access the **src/main/resources/base/media/example.png** image stored in the **resources** directory. For details about how to use **$r**/**$rawfile**, see [Resource Access: Application Resources](./resource-categories-and-access.md#application-resources). +In a project, application resources are referenced in the $r/$rawfile format. You can use **$r**/**$rawfile** to access resources in the **resources** directory of the current module. For example, you can use **$r("app.media.example")** to access the **src/main/resources/base/media/example.png** image stored in the **resources** directory. For details about how to use **$r**/**$rawfile**, see [Resource Access: Application Resources](./resource-categories-and-access.md). To avoid reference errors, do not use relative paths. For example, if you use **Image("../../resources/base/media/example.png")**, the image actually used will be the one in the directory of the module that invokes the HSP. That is, if the module that invokes the HSP is **entry**, then the image used will be **entry/src/main/resources/base/media/example.png**. diff --git a/en/application-dev/quick-start/module-configuration-file.md b/en/application-dev/quick-start/module-configuration-file.md index ac0482f454e..55ec4d2db93 100644 --- a/en/application-dev/quick-start/module-configuration-file.md +++ b/en/application-dev/quick-start/module-configuration-file.md @@ -342,7 +342,7 @@ The **abilities** tag represents the UIAbility configuration of the module, whic | preferMultiWindowOrientation | Multi-window orientation of the UIAbility.
- **default**: default value. Do not set this parameter to the default value. You are advised to set this parameter for other applications.
- **portrait**: portrait. This option is recommended for games in portrait mode.
- **landscape**: landscape. This option is recommended for games in landscape mode. With this option, the floating window and upper and lower split screens are supported in landscape mode.
- **landscape_auto**: automatically landscape. his option is recommended for games. It must be used together with the **enableLandScapeMultiWindow/disableLandScapeMultiWindow** API.| String| Yes (initial value: **default**)| | continueType | Continuation type of the UIAbility.| String array| Yes (initial value: name of the UIAbility)| | continueBundleName | List of other applications that support cross-device migration.
**NOTE**
This parameter cannot be set to the application bundle name. It is used only for migration with different bundle names.| String array| Yes (initial value: left empty)| -| process | Process tag of a component.
**NOTE**
This tag is valid only on the [2-in-1](./module-configuration-file.md#devicetypes tag) device. The UIAbility component and the ExtensionAbility component whose type is embeddedUI run in the same process when their tags are the same.| String| Yes (initial value: left empty)| +| process | Process tag of a component.
**NOTE**
This tag is valid only on the [2-in-1](./module-configuration-file.md#devicetypes) device. The UIAbility component and the ExtensionAbility component whose type is embeddedUI run in the same process when their tags are the same. | String| Yes (initial value: left empty)| Example of the **abilities** structure: @@ -492,7 +492,7 @@ The **extensionAbilities** tag represents the configuration of ExtensionAbilitie | exported | Whether the ExtensionAbility can be called by other applications.
- **true**: The ExtensionAbility can be called by other applications.
- **false**: The UIAbility cannot be called by other applications, not even by aa commands.| Boolean| Yes (initial value: **false**)| | extensionProcessMode | Multi-process instance model of the ExtensionAbility. Currently, this field is effective only for UIExtensionAbilities and ExtensionAbilities extended from UIExtensionAbilities.
- **instance**: Each instance of the ExtensionAbility has a process.
- **type**: All instances of the ExtensionAbility run in the same process, separated from other ExtensionAbility instances.
- **bundle**: All instances of the ExtensionAbility run in the same process as instances of other ExtensionAbilities using the **bundle** model.
- **runWithMainProcess**: Only the ExtensionAbility for one-step access runs in the same process with the application main process.| String| Yes (initial value: left empty)| | dataGroupIds | Data group IDs of the ExtensionAbility. If the application where the current ExtensionAbility component is located also applies for a **dataGroupId** in the **groupIds** of the certificate applied by the AppGallery, the current ExtensionAbility component can share the directory generated by the **dataGroupId** with the application, therefore, the **dataGroupId** of the ExtensionAbility component takes effect only when it is configured in the **groupIds** field in the application certificate. In addition, this attribute is effective only when the ExtensionAbility has an independent sandbox directory. For details, see [dataGroupId Application Process](https://developer.huawei.com/consumer/en/doc/harmonyos-guides/ime-kit-security#section4219152220459).| String array| Yes (initial value: left empty)| -| process | Process label of a component. This parameter can be set only when type is set to **embeddedUI**.
**NOTE**
This tag is valid only on the [2-in-1](./module-configuration-file.md#devicetypes tag) device. The UIAbility component and the ExtensionAbility component run in the same process when their tags are the same.| String| Yes (initial value: left empty)| +| process | Process label of a component. This parameter can be set only when type is set to **embeddedUI**.
**NOTE**
This tag is valid only on the [2-in-1](./module-configuration-file.md#devicetypes) device. The UIAbility component and the ExtensionAbility component run in the same process when their tags are the same. | String| Yes (initial value: left empty)| Example of the **extensionAbilities** structure: diff --git a/en/application-dev/reference/apis-arkdata/_o_h___cursor.md b/en/application-dev/reference/apis-arkdata/_o_h___cursor.md index 9dc20c8ccf7..619054b5a03 100644 --- a/en/application-dev/reference/apis-arkdata/_o_h___cursor.md +++ b/en/application-dev/reference/apis-arkdata/_o_h___cursor.md @@ -10,8 +10,6 @@ Provides APIs to access the result set obtained by querying the RDB store. **Related module**: [RDB](_r_d_b.md) -**Header file**: [oh_cursor.h](capi-oh-cursor-h.md) - ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_o_h___predicates.md b/en/application-dev/reference/apis-arkdata/_o_h___predicates.md index f5aa43176fc..dac793624af 100644 --- a/en/application-dev/reference/apis-arkdata/_o_h___predicates.md +++ b/en/application-dev/reference/apis-arkdata/_o_h___predicates.md @@ -9,8 +9,6 @@ Defines the predicates for RDB stores. **Related module**: [RDB](_r_d_b.md) -**Header file**: [oh_predicates.h](capi-oh-predicates-h.md) - ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_o_h___rdb___config.md b/en/application-dev/reference/apis-arkdata/_o_h___rdb___config.md index 46d38ca2e18..c77f811fd4e 100644 --- a/en/application-dev/reference/apis-arkdata/_o_h___rdb___config.md +++ b/en/application-dev/reference/apis-arkdata/_o_h___rdb___config.md @@ -9,8 +9,6 @@ Defines the RDB store configuration. **Related module**: [RDB](_r_d_b.md) -**Header file**: [relational_store.h](capi-relational-store-h.md) - ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_o_h___rdb___store.md b/en/application-dev/reference/apis-arkdata/_o_h___rdb___store.md index 84976037a14..40f9f3c89ba 100644 --- a/en/application-dev/reference/apis-arkdata/_o_h___rdb___store.md +++ b/en/application-dev/reference/apis-arkdata/_o_h___rdb___store.md @@ -9,8 +9,6 @@ Defines the RDB store type. **Related module**: [RDB](_r_d_b.md) -**Header file**: [relational_store.h](capi-relational-store-h.md) - ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_o_h___v_bucket.md b/en/application-dev/reference/apis-arkdata/_o_h___v_bucket.md index 6bb3a70a20c..53d3af35a01 100644 --- a/en/application-dev/reference/apis-arkdata/_o_h___v_bucket.md +++ b/en/application-dev/reference/apis-arkdata/_o_h___v_bucket.md @@ -9,8 +9,6 @@ Defines the types of the key and value in a KV pair. **Related module**: [RDB](_r_d_b.md) -**Header file**: [oh_values_bucket.h](capi-oh-values-bucket-h.md) - ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_o_h___v_object.md b/en/application-dev/reference/apis-arkdata/_o_h___v_object.md index c7d1907ff69..ef909e29993 100644 --- a/en/application-dev/reference/apis-arkdata/_o_h___v_object.md +++ b/en/application-dev/reference/apis-arkdata/_o_h___v_object.md @@ -9,8 +9,6 @@ Defines the allowed data field types. **Related module**: [RDB](_r_d_b.md) -**Header file**: [oh_value_object.h](capi-oh-value-object-h.md) - ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_r_d_b.md b/en/application-dev/reference/apis-arkdata/_r_d_b.md index 86949d9c430..78639a16337 100644 --- a/en/application-dev/reference/apis-arkdata/_r_d_b.md +++ b/en/application-dev/reference/apis-arkdata/_r_d_b.md @@ -23,7 +23,7 @@ The relational database (RDB) store manages data based on relational models. The | [oh_data_values_buckets.h](oh__data__values__buckets_8h.md) | Defines structs, APIs, and enums related to stored data values.
**File to include**:
**Library**: libnative_rdb_ndk.z.so
| | [oh_predicates.h](oh__predicates_8h.md) | Defines the predicates for RDB store operations.
**File to include**:
**Library**: libnative_rdb_ndk.z.so
| | [oh_rdb_transaction.h](oh__rdb__transaction_8h.md) | Defines APIs and enums related to transactions.
**File to include**:
**Library**: libnative_rdb_ndk.z.so
| -| [oh_rdb_types.h](oh__rdb__types_8h.md) | Defines types related to data values.
**File to include**:
**Library**: libnative_rdb_ndk.z.so
| +| [oh_rdb_types.h](oh__rdb__types_8h.md) | Defines types related to data values.
**File to include**:
**Library**: libnative_rdb_ndk.z.so
| | [oh_value_object.h](oh__value__object_8h.md) | Defines the APIs for type conversion.
**File to include**:
**Library**: libnative_rdb_ndk.z.so
| | [oh_values_bucket.h](oh__values__bucket_8h.md) | Defines the types of the key and value in a key-value (KV) pair.
**File to include**:
**Library**: libnative_rdb_ndk.z.so
| | [relational_store.h](relational__store_8h.md) | Provides APIs for managing data in an RDB store. The APIs not marked as supporting vector stores are available only to RDB stores.
**File to include**:
**Library**: libnative_rdb_ndk.z.so
| @@ -110,7 +110,7 @@ The relational database (RDB) store manages data based on relational models. The | Name| Description| | -------- | -------- | | [Rdb_DBType](#rdb_dbtype-1) { RDB_SQLITE = 1, RDB_CAYLEY = 2, DBTYPE_BUTT = 64 } | Enumerates the database kernel types.| -| [OH_OrderType](#oh_ordertype-1) { ASC = 0, DESC = 1 } | Enumerates the sorting types.| +| [OH_OrderType](#oh_ordertype) { ASC = 0, DESC = 1 } | Enumerates the sorting types.| | [OH_Rdb_SecurityLevel](#oh_rdb_securitylevel-1) { S1 = 1, S2, S3, S4 } | Enumerates the RDB store security levels.| | [Rdb_SecurityArea](#rdb_securityarea-1) { RDB_SECURITY_AREA_EL1 = 1, RDB_SECURITY_AREA_EL2, RDB_SECURITY_AREA_EL3, RDB_SECURITY_AREA_EL4 } | Enumerates the encryption levels of database files.| | [Rdb_DistributedType](#rdb_distributedtype-1) { RDB_DISTRIBUTED_CLOUD } | Enumerates the distributed types.| @@ -122,17 +122,17 @@ The relational database (RDB) store manages data based on relational models. The | [OH_ColumnType](#oh_columntype-1) {
TYPE_NULL = 0, TYPE_INT64, TYPE_REAL, TYPE_TEXT,
TYPE_BLOB, TYPE_ASSET, TYPE_ASSETS, TYPE_FLOAT_VECTOR,
TYPE_UNLIMITED_INT
} | Enumerates the column types.| | [OH_RDB_TransType](#oh_rdb_transtype-1) { RDB_TRANS_DEFERRED = 0, RDB_TRANS_IMMEDIATE, RDB_TRANS_EXCLUSIVE, RDB_TRANS_BUTT } | Enumerates the transaction types of an RDB store.| | [Rdb_Tokenizer](#rdb_tokenizer-1) { RDB_NONE_TOKENIZER = 1, RDB_ICU_TOKENIZER = 2, RDB_CUSTOM_TOKENIZER = 3 } | Enumerates the database tokenizer types.| -| [Rdb_ConflictResolution](#rdb_conflictresolution-1) {
RDB_CONFLICT_NONE = 1, RDB_CONFLICT_ROLLBACK, RDB_CONFLICT_ABORT, RDB_CONFLICT_FAIL,
RDB_CONFLICT_IGNORE, RDB_CONFLICT_REPLACE
} | Enumerates the conflict resolution policies.| -| [OH_Rdb_ErrCode](#oh_rdb_errcode-1) {
RDB_ERR = -1, RDB_OK = 0, E_BASE = 14800000, RDB_E_NOT_SUPPORTED = 801,
RDB_E_ERROR = E_BASE, RDB_E_INVALID_ARGS = (E_BASE + 1), RDB_E_CANNOT_UPDATE_READONLY = (E_BASE + 2), RDB_E_REMOVE_FILE = (E_BASE + 3),
RDB_E_EMPTY_TABLE_NAME = (E_BASE + 5), RDB_E_EMPTY_VALUES_BUCKET = (E_BASE + 6), RDB_E_EXECUTE_IN_STEP_QUERY = (E_BASE + 7), RDB_E_INVALID_COLUMN_INDEX = (E_BASE + 8),
RDB_E_INVALID_COLUMN_TYPE = (E_BASE + 9), RDB_E_EMPTY_FILE_NAME = (E_BASE + 10), RDB_E_INVALID_FILE_PATH = (E_BASE + 11), RDB_E_TRANSACTION_IN_EXECUTE = (E_BASE + 12),
RDB_E_INVALID_STATEMENT = (E_BASE + 13), RDB_E_EXECUTE_WRITE_IN_READ_CONNECTION = (E_BASE + 14), RDB_E_BEGIN_TRANSACTION_IN_READ_CONNECTION = (E_BASE + 15), RDB_E_NO_TRANSACTION_IN_SESSION = (E_BASE + 16),
RDB_E_MORE_STEP_QUERY_IN_ONE_SESSION = (E_BASE + 17), RDB_E_NO_ROW_IN_QUERY = (E_BASE + 18), RDB_E_INVALID_BIND_ARGS_COUNT = (E_BASE + 19), RDB_E_INVALID_OBJECT_TYPE = (E_BASE + 20),
RDB_E_INVALID_CONFLICT_FLAG = (E_BASE + 21), RDB_E_HAVING_CLAUSE_NOT_IN_GROUP_BY = (E_BASE + 22), RDB_E_NOT_SUPPORTED_BY_STEP_RESULT_SET = (E_BASE + 23), RDB_E_STEP_RESULT_SET_CROSS_THREADS = (E_BASE + 24),
RDB_E_STEP_RESULT_QUERY_NOT_EXECUTED = (E_BASE + 25), RDB_E_STEP_RESULT_IS_AFTER_LAST = (E_BASE + 26), RDB_E_STEP_RESULT_QUERY_EXCEEDED = (E_BASE + 27), RDB_E_STATEMENT_NOT_PREPARED = (E_BASE + 28),
RDB_E_EXECUTE_RESULT_INCORRECT = (E_BASE + 29), RDB_E_STEP_RESULT_CLOSED = (E_BASE + 30), RDB_E_RELATIVE_PATH = (E_BASE + 31), RDB_E_EMPTY_NEW_ENCRYPT_KEY = (E_BASE + 32),
RDB_E_CHANGE_UNENCRYPTED_TO_ENCRYPTED = (E_BASE + 33), RDB_E_CHANGE_ENCRYPT_KEY_IN_BUSY = (E_BASE + 34), RDB_E_STEP_STATEMENT_NOT_INIT = (E_BASE + 35), RDB_E_NOT_SUPPORTED_ATTACH_IN_WAL_MODE = (E_BASE + 36),
RDB_E_CREATE_FOLDER_FAIL = (E_BASE + 37), RDB_E_SQLITE_SQL_BUILDER_NORMALIZE_FAIL = (E_BASE + 38), RDB_E_STORE_SESSION_NOT_GIVE_CONNECTION_TEMPORARILY = (E_BASE + 39), RDB_E_STORE_SESSION_NO_CURRENT_TRANSACTION = (E_BASE + 40),
RDB_E_NOT_SUPPORT = (E_BASE + 41), RDB_E_INVALID_PARCEL = (E_BASE + 42), RDB_E_QUERY_IN_EXECUTE = (E_BASE + 43), RDB_E_SET_PERSIST_WAL = (E_BASE + 44),
RDB_E_DB_NOT_EXIST = (E_BASE + 45), RDB_E_ARGS_READ_CON_OVERLOAD = (E_BASE + 46), RDB_E_WAL_SIZE_OVER_LIMIT = (E_BASE + 47), RDB_E_CON_OVER_LIMIT = (E_BASE + 48),
RDB_E_ALREADY_CLOSED = (E_BASE + 50), RDB_E_DATABASE_BUSY = (E_BASE + 51), RDB_E_SQLITE_CORRUPT = (E_BASE + 52), RDB_E_SQLITE_PERM = (E_BASE + 53),
RDB_E_SQLITE_BUSY = (E_BASE + 54), RDB_E_SQLITE_LOCKED = (E_BASE + 55), RDB_E_SQLITE_NOMEM = (E_BASE + 56), RDB_E_SQLITE_READONLY = (E_BASE + 57),
RDB_E_SQLITE_IOERR = (E_BASE + 58), RDB_E_SQLITE_FULL = (E_BASE + 59), RDB_E_SQLITE_CANT_OPEN = (E_BASE + 60), RDB_E_SQLITE_TOO_BIG = (E_BASE + 61),
RDB_E_SQLITE_MISMATCH = (E_BASE + 62), RDB_E_DATA_TYPE_NULL = (E_BASE + 63), RDB_E_TYPE_MISMATCH = (E_BASE + 64), RDB_E_SQLITE_CONSTRAINT = (E_BASE + 65)
} | Enumerates the RDB store error codes.| +| [Rdb_ConflictResolution](#rdb_conflictresolution-1) {
RDB_CONFLICT_NONE = 1, RDB_CONFLICT_ROLLBACK, RDB_CONFLICT_ABORT, RDB_CONFLICT_FAIL,
RDB_CONFLICT_IGNORE, RDB_CONFLICT_REPLACE
} | Enumerates the conflict resolution policies.| +| [OH_Rdb_ErrCode](#oh_rdb_errcode-1) {
RDB_ERR = -1, RDB_OK = 0, E_BASE = 14800000, RDB_E_NOT_SUPPORTED = 801,
RDB_E_ERROR = E_BASE, RDB_E_INVALID_ARGS = (E_BASE + 1), RDB_E_CANNOT_UPDATE_READONLY = (E_BASE + 2), RDB_E_REMOVE_FILE = (E_BASE + 3),
RDB_E_EMPTY_TABLE_NAME = (E_BASE + 5), RDB_E_EMPTY_VALUES_BUCKET = (E_BASE + 6), RDB_E_EXECUTE_IN_STEP_QUERY = (E_BASE + 7), RDB_E_INVALID_COLUMN_INDEX = (E_BASE + 8),
RDB_E_INVALID_COLUMN_TYPE = (E_BASE + 9), RDB_E_EMPTY_FILE_NAME = (E_BASE + 10), RDB_E_INVALID_FILE_PATH = (E_BASE + 11), RDB_E_TRANSACTION_IN_EXECUTE = (E_BASE + 12),
RDB_E_INVALID_STATEMENT = (E_BASE + 13), RDB_E_EXECUTE_WRITE_IN_READ_CONNECTION = (E_BASE + 14), RDB_E_BEGIN_TRANSACTION_IN_READ_CONNECTION = (E_BASE + 15), RDB_E_NO_TRANSACTION_IN_SESSION = (E_BASE + 16),
RDB_E_MORE_STEP_QUERY_IN_ONE_SESSION = (E_BASE + 17), RDB_E_NO_ROW_IN_QUERY = (E_BASE + 18), RDB_E_INVALID_BIND_ARGS_COUNT = (E_BASE + 19), RDB_E_INVALID_OBJECT_TYPE = (E_BASE + 20),
RDB_E_INVALID_CONFLICT_FLAG = (E_BASE + 21), RDB_E_HAVING_CLAUSE_NOT_IN_GROUP_BY = (E_BASE + 22), RDB_E_NOT_SUPPORTED_BY_STEP_RESULT_SET = (E_BASE + 23), RDB_E_STEP_RESULT_SET_CROSS_THREADS = (E_BASE + 24),
RDB_E_STEP_RESULT_QUERY_NOT_EXECUTED = (E_BASE + 25), RDB_E_STEP_RESULT_IS_AFTER_LAST = (E_BASE + 26), RDB_E_STEP_RESULT_QUERY_EXCEEDED = (E_BASE + 27), RDB_E_STATEMENT_NOT_PREPARED = (E_BASE + 28),
RDB_E_EXECUTE_RESULT_INCORRECT = (E_BASE + 29), RDB_E_STEP_RESULT_CLOSED = (E_BASE + 30), RDB_E_RELATIVE_PATH = (E_BASE + 31), RDB_E_EMPTY_NEW_ENCRYPT_KEY = (E_BASE + 32),
RDB_E_CHANGE_UNENCRYPTED_TO_ENCRYPTED = (E_BASE + 33), RDB_E_CHANGE_ENCRYPT_KEY_IN_BUSY = (E_BASE + 34), RDB_E_STEP_STATEMENT_NOT_INIT = (E_BASE + 35), RDB_E_NOT_SUPPORTED_ATTACH_IN_WAL_MODE = (E_BASE + 36),
RDB_E_CREATE_FOLDER_FAIL = (E_BASE + 37), RDB_E_SQLITE_SQL_BUILDER_NORMALIZE_FAIL = (E_BASE + 38), RDB_E_STORE_SESSION_NOT_GIVE_CONNECTION_TEMPORARILY = (E_BASE + 39), RDB_E_STORE_SESSION_NO_CURRENT_TRANSACTION = (E_BASE + 40),
RDB_E_NOT_SUPPORT = (E_BASE + 41), RDB_E_INVALID_PARCEL = (E_BASE + 42), RDB_E_QUERY_IN_EXECUTE = (E_BASE + 43), RDB_E_SET_PERSIST_WAL = (E_BASE + 44),
RDB_E_DB_NOT_EXIST = (E_BASE + 45), RDB_E_ARGS_READ_CON_OVERLOAD = (E_BASE + 46), RDB_E_WAL_SIZE_OVER_LIMIT = (E_BASE + 47), RDB_E_CON_OVER_LIMIT = (E_BASE + 48),
RDB_E_ALREADY_CLOSED = (E_BASE + 50), RDB_E_DATABASE_BUSY = (E_BASE + 51), RDB_E_SQLITE_CORRUPT = (E_BASE + 52), RDB_E_SQLITE_PERM = (E_BASE + 53),
RDB_E_SQLITE_BUSY = (E_BASE + 54), RDB_E_SQLITE_LOCKED = (E_BASE + 55), RDB_E_SQLITE_NOMEM = (E_BASE + 56), RDB_E_SQLITE_READONLY = (E_BASE + 57),
RDB_E_SQLITE_IOERR = (E_BASE + 58), RDB_E_SQLITE_FULL = (E_BASE + 59), RDB_E_SQLITE_CANT_OPEN = (E_BASE + 60), RDB_E_SQLITE_TOO_BIG = (E_BASE + 61),
RDB_E_SQLITE_MISMATCH = (E_BASE + 62), RDB_E_DATA_TYPE_NULL = (E_BASE + 63), RDB_E_TYPE_MISMATCH = (E_BASE + 64), RDB_E_SQLITE_CONSTRAINT = (E_BASE + 65)
} | Enumerates the RDB store error codes.| ### Functions | Name| Description| | -------- | -------- | -| int [OH_RdbTrans_BatchInsert](#oh_rdbtrans_batchinsert) ([OH_Rdb_Transaction](#oh_rdb_transaction) \*trans, const char \*table, const [OH_Data_VBuckets](#oh_data_vbuckets) \*rows, [Rdb_ConflictResolution](#rdb_conflictresolution) resolution, int64_t \*changes) | Inserts a batch of data into a table.| -| int [OH_Rdb_BatchInsert](#oh_rdb_batchinsert) ([OH_Rdb_Store](_o_h___rdb___store.md) \*store, const char \*table, const [OH_Data_VBuckets](#oh_data_vbuckets) \*rows, [Rdb_ConflictResolution](#rdb_conflictresolution) resolution, int64_t \*changes) | Inserts a batch of data into a table.| -| int [OH_Rdb_SetPersistent](#oh_rdb_setpersistent) ([OH_Rdb_ConfigV2](#oh_rdb_configv2) \*config, bool isPersistent) | Sets whether to persist an RDB store.| +| int [OH_RdbTrans_BatchInsert](#oh_rdbtrans_batchinsert) ([OH_Rdb_Transaction](#oh_rdb_transaction) \*trans, const char \*table, const [OH_Data_VBuckets](#oh_data_vbuckets) \*rows, [Rdb_ConflictResolution](#rdb_conflictresolution) resolution, int64_t \*changes) | Inserts a batch of data into a table.| +| int [OH_Rdb_BatchInsert](#oh_rdb_batchinsert) ([OH_Rdb_Store](_o_h___rdb___store.md) \*store, const char \*table, const [OH_Data_VBuckets](#oh_data_vbuckets) \*rows, [Rdb_ConflictResolution](#rdb_conflictresolution) resolution, int64_t \*changes) | Inserts a batch of data into a table.| +| int [OH_Rdb_SetPersistent](#oh_rdb_setpersistent) ([OH_Rdb_ConfigV2](#oh_rdb_configv2) \*config, bool isPersistent) | Sets whether to persist an RDB store.| | int [OH_Rdb_IsTokenizerSupported](#oh_rdb_istokenizersupported) ([Rdb_Tokenizer](#rdb_tokenizer) tokenizer, bool \*isSupported) | Checks whether the specified tokenizer is supported.| | int [OH_Rdb_SetTokenizer](#oh_rdb_settokenizer) ([OH_Rdb_ConfigV2](#oh_rdb_configv2) \*config, [Rdb_Tokenizer](#rdb_tokenizer) tokenizer) | Sets the tokenizer type.| | int [OH_Cursor_GetFloatVectorCount](#oh_cursor_getfloatvectorcount) ([OH_Cursor](_o_h___cursor.md) \*cursor, int32_t columnIndex, size_t \*length) | Obtains the length of the float array in the specified column of the current row.| @@ -948,14 +948,14 @@ Enumerates the conflict resolution policies. **Since**: 18 -| Value| Description| +| Value| Description| | -------- | -------- | -| RDB_CONFLICT_NONE | No operation is performed when a conflict occurs.| -| RDB_CONFLICT_ROLLBACK | Throw an error and roll back the transaction.| -| RDB_CONFLICT_ABORT | Throw an error and roll back the current change.| -| RDB_CONFLICT_FAIL | Throw an error and abort the current change without rolling back the modifications before the conflict.| -| RDB_CONFLICT_IGNORE | Ignore the conflicted data and resolve the conflict later.| -| RDB_CONFLICT_REPLACE | Delete the data and then insert the data. If the conflict persists, apply **RDB_CONFLICT_ABORT**.| +| RDB_CONFLICT_NONE | No operation is performed when a conflict occurs.| +| RDB_CONFLICT_ROLLBACK | Throw an error and roll back the transaction.| +| RDB_CONFLICT_ABORT | Throw an error and roll back the current change.| +| RDB_CONFLICT_FAIL | Throw an error and abort the current change without rolling back the modifications before the conflict.| +| RDB_CONFLICT_IGNORE | Ignore the conflicted data and resolve the conflict later.| +| RDB_CONFLICT_REPLACE | Delete the data and then insert the data. If the conflict persists, apply **RDB_CONFLICT_ABORT**.| ### OH_Rdb_ErrCode @@ -969,76 +969,76 @@ Enumerates the error codes. **Since**: 10 -| Value| Description| -| -------- | -------- | -| RDB_ERR | Execution failed.| -| RDB_OK | Execution successful.| -| E_BASE | Base of the error code.| -| RDB_E_NOT_SUPPORTED | The RDB store does not have this capability.| -| RDB_E_ERROR | Common exception.| -| RDB_E_INVALID_ARGS | Invalid parameter.| -| RDB_E_CANNOT_UPDATE_READONLY | Failed to update data because the RDB store is read-only.| -| RDB_E_REMOVE_FILE | Failed to delete the file.| -| RDB_E_EMPTY_TABLE_NAME | The table name is empty.| -| RDB_E_EMPTY_VALUES_BUCKET | The content of the KV pair is empty.| -| RDB_E_EXECUTE_IN_STEP_QUERY | The SQL statement executed during the query is incorrect.| -| RDB_E_INVALID_COLUMN_INDEX | The column index is invalid.| -| RDB_E_INVALID_COLUMN_TYPE | The column type is invalid.| -| RDB_E_EMPTY_FILE_NAME | The file name is empty.| -| RDB_E_INVALID_FILE_PATH | The file path is invalid.| -| RDB_E_TRANSACTION_IN_EXECUTE | Failed to start the transaction.| -| RDB_E_INVALID_STATEMENT | Failed to precompile the SQL statements.| -| RDB_E_EXECUTE_WRITE_IN_READ_CONNECTION | Failed to perform a write operation in a read connection.| -| RDB_E_BEGIN_TRANSACTION_IN_READ_CONNECTION | Failed to start the transaction in a read connection.| -| RDB_E_NO_TRANSACTION_IN_SESSION | The transaction to start does not exist in the database session.| -| RDB_E_MORE_STEP_QUERY_IN_ONE_SESSION | Multiple queries are executed in a database session.| -| RDB_E_NO_ROW_IN_QUERY | The result set does not contain any record.| -| RDB_E_INVALID_BIND_ARGS_COUNT | The number of parameters bound in the SQL statement is invalid.| -| RDB_E_INVALID_OBJECT_TYPE | The object type is invalid.| -| RDB_E_INVALID_CONFLICT_FLAG | The conflict resolution type is invalid.| -| RDB_E_HAVING_CLAUSE_NOT_IN_GROUP_BY | The **HAVING** keyword can be used only after **GROUP BY**.| -| RDB_E_NOT_SUPPORTED_BY_STEP_RESULT_SET | The result set by step is not supported.| -| RDB_E_STEP_RESULT_SET_CROSS_THREADS | Failed to obtain the result set.| -| RDB_E_STEP_RESULT_QUERY_NOT_EXECUTED | The result set query statement is not executed.| -| RDB_E_STEP_RESULT_IS_AFTER_LAST | The pointer of the result set is already in the last row.| -| RDB_E_STEP_RESULT_QUERY_EXCEEDED | The number of result set query times exceeds the limit.| -| RDB_E_STATEMENT_NOT_PREPARED | The SQL statement is not precompiled.| -| RDB_E_EXECUTE_RESULT_INCORRECT | The database execution result is incorrect.| -| RDB_E_STEP_RESULT_CLOSED | The result set has been closed.| -| RDB_E_RELATIVE_PATH | The file path is a relative path.| -| RDB_E_EMPTY_NEW_ENCRYPT_KEY | The new encrypt key is empty.| -| RDB_E_CHANGE_UNENCRYPTED_TO_ENCRYPTED | The RDB store is non-encrypted and cannot be changed.| -| RDB_E_CHANGE_ENCRYPT_KEY_IN_BUSY | The database does not respond when the database key is updated.| -| RDB_E_STEP_STATEMENT_NOT_INIT | The precompiled SQL statement is not initialized.| -| RDB_E_NOT_SUPPORTED_ATTACH_IN_WAL_MODE | The WAL mode does not support the ATTACH operation.| -| RDB_E_CREATE_FOLDER_FAIL | Failed to create the folder.| -| RDB_E_SQLITE_SQL_BUILDER_NORMALIZE_FAIL | Failed to build the SQL statement.| -| RDB_E_STORE_SESSION_NOT_GIVE_CONNECTION_TEMPORARILY | The database session does not provide a connection.| -| RDB_E_STORE_SESSION_NO_CURRENT_TRANSACTION | The transaction does not exist in the database session.| -| RDB_E_NOT_SUPPORT | The current operation is not supported.| -| RDB_E_INVALID_PARCEL | The current PARCEL is invalid.| -| RDB_E_QUERY_IN_EXECUTE | Failed to execute query.| -| RDB_E_SET_PERSIST_WAL | Failed to set the persistence of the database file in WAL mode.| -| RDB_E_DB_NOT_EXIST | The database does not exist.| -| RDB_E_ARGS_READ_CON_OVERLOAD | The number of read connections to set is greater than the limit.| -| RDB_E_WAL_SIZE_OVER_LIMIT | The WAL log file size exceeds the default value.| -| RDB_E_CON_OVER_LIMIT | The number of database connections has reached the limit.| -| RDB_E_ALREADY_CLOSED18+ | The RDB store is already closed.| -| RDB_E_DATABASE_BUSY18+ | The database does not respond.| -| RDB_E_SQLITE_CORRUPT18+ | The database is corrupted.| -| RDB_E_SQLITE_PERM18+ | SQLite: access denied.| -| RDB_E_SQLITE_BUSY18+ | SQLite: database file locked.| -| RDB_E_SQLITE_LOCKED18+ | SQLite: database table locked.| -| RDB_E_SQLITE_NOMEM18+ | SQLite: insufficient database memory.| -| RDB_E_SQLITE_READONLY18+ | SQLite: attempt to write a read-only database.| -| RDB_E_SQLITE_IOERR18+ | SQLite: disk I/O error.| -| RDB_E_SQLITE_FULL18+ | SQLite: database is full.| -| RDB_E_SQLITE_CANT_OPEN18+ | SQLite: unable to open the database file.| -| RDB_E_SQLITE_TOO_BIG18+ | SQLite: TEXT or BLOB exceeds the limit.| -| RDB_E_SQLITE_MISMATCH18+ | SQLite: data types mismatch.| -| RDB_E_DATA_TYPE_NULL18+ | The data to be stored is empty.| -| RDB_E_TYPE_MISMATCH18+ | The data type is incorrect.| -| RDB_E_SQLITE_CONSTRAINT18+ | SQLite error code: SQLite constraint.| +| Value| Description| +| -------- | -------- | +| RDB_ERR | Execution failed.| +| RDB_OK | Execution successful.| +| E_BASE | Base of the error code.| +| RDB_E_NOT_SUPPORTED | The RDB store does not have this capability.| +| RDB_E_ERROR | Common exception.| +| RDB_E_INVALID_ARGS | Invalid parameter.| +| RDB_E_CANNOT_UPDATE_READONLY | Failed to update data because the RDB store is read-only.| +| RDB_E_REMOVE_FILE | Failed to delete the file.| +| RDB_E_EMPTY_TABLE_NAME | The table name is empty.| +| RDB_E_EMPTY_VALUES_BUCKET | The content of the KV pair is empty.| +| RDB_E_EXECUTE_IN_STEP_QUERY | The SQL statement executed during the query is incorrect.| +| RDB_E_INVALID_COLUMN_INDEX | The column index is invalid.| +| RDB_E_INVALID_COLUMN_TYPE | The column type is invalid.| +| RDB_E_EMPTY_FILE_NAME | The file name is empty.| +| RDB_E_INVALID_FILE_PATH | The file path is invalid.| +| RDB_E_TRANSACTION_IN_EXECUTE | Failed to start the transaction.| +| RDB_E_INVALID_STATEMENT | Failed to precompile the SQL statements.| +| RDB_E_EXECUTE_WRITE_IN_READ_CONNECTION | Failed to perform a write operation in a read connection.| +| RDB_E_BEGIN_TRANSACTION_IN_READ_CONNECTION | Failed to start the transaction in a read connection.| +| RDB_E_NO_TRANSACTION_IN_SESSION | The transaction to start does not exist in the database session.| +| RDB_E_MORE_STEP_QUERY_IN_ONE_SESSION | Multiple queries are executed in a database session.| +| RDB_E_NO_ROW_IN_QUERY | The result set does not contain any record.| +| RDB_E_INVALID_BIND_ARGS_COUNT | The number of parameters bound in the SQL statement is invalid.| +| RDB_E_INVALID_OBJECT_TYPE | The object type is invalid.| +| RDB_E_INVALID_CONFLICT_FLAG | The conflict resolution type is invalid.| +| RDB_E_HAVING_CLAUSE_NOT_IN_GROUP_BY | The **HAVING** keyword can be used only after **GROUP BY**.| +| RDB_E_NOT_SUPPORTED_BY_STEP_RESULT_SET | The result set by step is not supported.| +| RDB_E_STEP_RESULT_SET_CROSS_THREADS | Failed to obtain the result set.| +| RDB_E_STEP_RESULT_QUERY_NOT_EXECUTED | The result set query statement is not executed.| +| RDB_E_STEP_RESULT_IS_AFTER_LAST | The pointer of the result set is already in the last row.| +| RDB_E_STEP_RESULT_QUERY_EXCEEDED | The number of result set query times exceeds the limit.| +| RDB_E_STATEMENT_NOT_PREPARED | The SQL statement is not precompiled.| +| RDB_E_EXECUTE_RESULT_INCORRECT | The database execution result is incorrect.| +| RDB_E_STEP_RESULT_CLOSED | The result set has been closed.| +| RDB_E_RELATIVE_PATH | The file path is a relative path.| +| RDB_E_EMPTY_NEW_ENCRYPT_KEY | The new encrypt key is empty.| +| RDB_E_CHANGE_UNENCRYPTED_TO_ENCRYPTED | The RDB store is non-encrypted and cannot be changed.| +| RDB_E_CHANGE_ENCRYPT_KEY_IN_BUSY | The database does not respond when the database key is updated.| +| RDB_E_STEP_STATEMENT_NOT_INIT | The precompiled SQL statement is not initialized.| +| RDB_E_NOT_SUPPORTED_ATTACH_IN_WAL_MODE | The WAL mode does not support the ATTACH operation.| +| RDB_E_CREATE_FOLDER_FAIL | Failed to create the folder.| +| RDB_E_SQLITE_SQL_BUILDER_NORMALIZE_FAIL | Failed to build the SQL statement.| +| RDB_E_STORE_SESSION_NOT_GIVE_CONNECTION_TEMPORARILY | The database session does not provide a connection.| +| RDB_E_STORE_SESSION_NO_CURRENT_TRANSACTION | The transaction does not exist in the database session.| +| RDB_E_NOT_SUPPORT | The current operation is not supported.| +| RDB_E_INVALID_PARCEL | The current PARCEL is invalid.| +| RDB_E_QUERY_IN_EXECUTE | Failed to execute query.| +| RDB_E_SET_PERSIST_WAL | Failed to set the persistence of the database file in WAL mode.| +| RDB_E_DB_NOT_EXIST | The database does not exist.| +| RDB_E_ARGS_READ_CON_OVERLOAD | The number of read connections to set is greater than the limit.| +| RDB_E_WAL_SIZE_OVER_LIMIT | The WAL log file size exceeds the default value.| +| RDB_E_CON_OVER_LIMIT | The number of database connections has reached the limit.| +| RDB_E_ALREADY_CLOSED18+ | The RDB store is already closed.| +| RDB_E_DATABASE_BUSY18+ | The database does not respond.| +| RDB_E_SQLITE_CORRUPT18+ | The database is corrupted.| +| RDB_E_SQLITE_PERM18+ | SQLite: access denied.| +| RDB_E_SQLITE_BUSY18+ | SQLite: database file locked.| +| RDB_E_SQLITE_LOCKED18+ | SQLite: database table locked.| +| RDB_E_SQLITE_NOMEM18+ | SQLite: insufficient database memory.| +| RDB_E_SQLITE_READONLY18+ | SQLite: attempt to write a read-only database.| +| RDB_E_SQLITE_IOERR18+ | SQLite: disk I/O error.| +| RDB_E_SQLITE_FULL18+ | SQLite: database is full.| +| RDB_E_SQLITE_CANT_OPEN18+ | SQLite: unable to open the database file.| +| RDB_E_SQLITE_TOO_BIG18+ | SQLite: TEXT or BLOB exceeds the limit.| +| RDB_E_SQLITE_MISMATCH18+ | SQLite: data types mismatch.| +| RDB_E_DATA_TYPE_NULL18+ | The data to be stored is empty.| +| RDB_E_TYPE_MISMATCH18+ | The data type is incorrect.| +| RDB_E_SQLITE_CONSTRAINT18+ | SQLite error code: SQLite constraint.| ### OH_ColumnType @@ -1290,13 +1290,13 @@ Inserts a batch of data into a table. **Parameters** -| Name| Description| +| Name| Description| | -------- | -------- | -| trans | Pointer to the [OH_Rdb_Transaction](#oh_rdb_transaction) instance.| -| table | Pointer to the target table.| -| rows | Pointer to the rows of data to insert.| -| resolution | Policy used to resolve file conflicts.| -| changes | Pointer to the number of successful insertions.| +| trans | Pointer to the [OH_Rdb_Transaction](#oh_rdb_transaction) instance.| +| table | Pointer to the target table.| +| rows | Pointer to the rows of data to insert.| +| resolution | Policy used to resolve file conflicts.| +| changes | Pointer to the number of successful insertions.| **Returns** @@ -1349,13 +1349,13 @@ Inserts a batch of data into a table. **Parameters** -| Name| Description| +| Name| Description| | -------- | -------- | -| store | Pointer to the [OH_Rdb_Store](_o_h___rdb___store.md) instance.| -| tables | Pointer to the names of the distributed tables to set.| -| rows | Pointer to the rows of data to insert.| -| resolution | Policy used to resolve file conflicts.| -| changes | Pointer to the number of successful insertions.| +| store | Pointer to the [OH_Rdb_Store](_o_h___rdb___store.md) instance.| +| tables | Pointer to the names of the distributed tables to set.| +| rows | Pointer to the rows of data to insert.| +| resolution | Policy used to resolve file conflicts.| +| changes | Pointer to the number of successful insertions.| **Returns** @@ -1406,7 +1406,7 @@ Sets whether to persist an RDB store. **Parameters** -| Name| Description| +| Name| Description| | -------- | -------- | | config | Pointer to the target **OH_Rdb_ConfigV2** instance, which specifies the database configuration.| | isPersistent | Whether to persist the database data.| diff --git a/en/application-dev/reference/apis-arkdata/_rdb___change_info.md b/en/application-dev/reference/apis-arkdata/_rdb___change_info.md index d754cc8eb69..2d41b6ec9c6 100644 --- a/en/application-dev/reference/apis-arkdata/_rdb___change_info.md +++ b/en/application-dev/reference/apis-arkdata/_rdb___change_info.md @@ -9,8 +9,6 @@ Defines a struct for the details about the device-cloud sync process. **Related module**: [RDB](_r_d_b.md) -**Header file**: [relational_store.h](capi-relational-store-h.md) - ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_rdb___data_observer.md b/en/application-dev/reference/apis-arkdata/_rdb___data_observer.md index 16fdcce12da..06f2ab11990 100644 --- a/en/application-dev/reference/apis-arkdata/_rdb___data_observer.md +++ b/en/application-dev/reference/apis-arkdata/_rdb___data_observer.md @@ -9,8 +9,6 @@ Defines the data observer. **Related module**: [RDB](_r_d_b.md) -**Header file**: [relational_store.h](capi-relational-store-h.md) - ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_rdb___distributed_config.md b/en/application-dev/reference/apis-arkdata/_rdb___distributed_config.md index 2b37af5ad57..d84b0e4bfd1 100644 --- a/en/application-dev/reference/apis-arkdata/_rdb___distributed_config.md +++ b/en/application-dev/reference/apis-arkdata/_rdb___distributed_config.md @@ -9,8 +9,6 @@ Defines a struct for distributed configuration of a table. **Related module**: [RDB](_r_d_b.md) -**Header file**: [relational_store.h](capi-relational-store-h.md) - ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_rdb___key_info.md b/en/application-dev/reference/apis-arkdata/_rdb___key_info.md index 662347e898f..53b9caa4217 100644 --- a/en/application-dev/reference/apis-arkdata/_rdb___key_info.md +++ b/en/application-dev/reference/apis-arkdata/_rdb___key_info.md @@ -9,8 +9,6 @@ Defines a struct for the primary key or row number of the row that changes. **Related module**: [RDB](_r_d_b.md) -**Header file**: [relational_store.h](capi-relational-store-h.md) - ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_rdb___progress_details.md b/en/application-dev/reference/apis-arkdata/_rdb___progress_details.md index 802ffe82af5..90f9b958005 100644 --- a/en/application-dev/reference/apis-arkdata/_rdb___progress_details.md +++ b/en/application-dev/reference/apis-arkdata/_rdb___progress_details.md @@ -9,8 +9,6 @@ Defines a struct for statistics of the overall device-cloud sync (upload and dow **Related module**: [RDB](_r_d_b.md) -**Header file**: [relational_store.h](capi-relational-store-h.md) - ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_rdb___progress_observer.md b/en/application-dev/reference/apis-arkdata/_rdb___progress_observer.md index e1b06501165..ed7d584a78c 100644 --- a/en/application-dev/reference/apis-arkdata/_rdb___progress_observer.md +++ b/en/application-dev/reference/apis-arkdata/_rdb___progress_observer.md @@ -9,8 +9,6 @@ Defines the observer for the device-cloud sync progress. **Related module**: [RDB](_r_d_b.md) -**Header file**: [relational_store.h](capi-relational-store-h.md) - ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_rdb___statistic.md b/en/application-dev/reference/apis-arkdata/_rdb___statistic.md index 276a9e957b3..5754be6b6a7 100644 --- a/en/application-dev/reference/apis-arkdata/_rdb___statistic.md +++ b/en/application-dev/reference/apis-arkdata/_rdb___statistic.md @@ -9,8 +9,6 @@ Defines a struct for the device-cloud sync statistics of a database table. **Related module**: [RDB](_r_d_b.md) -**Header file**: [relational_store.h](capi-relational-store-h.md) - ## Summary diff --git a/en/application-dev/reference/apis-arkdata/_rdb___table_details.md b/en/application-dev/reference/apis-arkdata/_rdb___table_details.md index 62b9e04fc75..3509efe1fe4 100644 --- a/en/application-dev/reference/apis-arkdata/_rdb___table_details.md +++ b/en/application-dev/reference/apis-arkdata/_rdb___table_details.md @@ -9,8 +9,6 @@ Defines a struct for statistics of device-cloud upload and download tasks of a d **Related module**: [RDB](_r_d_b.md) -**Header file**: [relational_store.h](capi-relational-store-h.md) - ## Summary diff --git a/en/application-dev/reference/apis-arkdata/js-apis-data-commonType.md b/en/application-dev/reference/apis-arkdata/js-apis-data-commonType.md index a08d0ed0b6a..31e2ddfc34d 100644 --- a/en/application-dev/reference/apis-arkdata/js-apis-data-commonType.md +++ b/en/application-dev/reference/apis-arkdata/js-apis-data-commonType.md @@ -29,7 +29,7 @@ Enumerates the asset statuses. Use the enum name rather than the enum value. ## Asset -Represents asset (such as a file, image, or video) information. For details, see the sample code in [Using Distributed Data Objects in Cross-Device Migration](../../database/data-sync-of-distributed-data-object.md#using-distributed-data-objects-in-cross-device migration). +Represents asset (such as a file, image, or video) information. For details, see the sample code in [Using Distributed Data Objects in Cross-Device Migration](../../database/data-sync-of-distributed-data-object.md#using-distributed-data-objects-in-cross-device-migration). **System capability**: SystemCapability.DistributedDataManager.CommonType diff --git a/en/application-dev/reference/apis-arkdata/js-apis-data-preferences.md b/en/application-dev/reference/apis-arkdata/js-apis-data-preferences.md index 99cb8423278..d6a790d14d2 100644 --- a/en/application-dev/reference/apis-arkdata/js-apis-data-preferences.md +++ b/en/application-dev/reference/apis-arkdata/js-apis-data-preferences.md @@ -4,7 +4,7 @@ The **Preferences** module provides APIs for processing data in the form of key- The key is of the string type, and the value can be a number, a string, a Boolean value, or an array of numbers, strings, or Boolean values. -The user preference persistent files are stored in the [preferencesDir](../../application-models/application-context-stage.md#obtaining-application-file-path) directory. Before creating a preferences object, ensure that the **preferencesDir** directory is readable and writeable. The [encryption level](../apis-ability-kit/js-apis-app-ability-contextConstant.md#areamode) of the persistent file directory determines the access to the files. For details, see [Application File Directory and Application File Path](../../file-management/app-sandbox-directory.md#application-file-directory-and-application-file-path). +The user preference persistent files are stored in the [preferencesDir](../../application-models/application-context-stage.md#obtaining-application-file-paths) directory. Before creating a preferences object, ensure that the **preferencesDir** directory is readable and writeable. The [encryption level](../apis-ability-kit/js-apis-app-ability-contextConstant.md#areamode) of the persistent file directory determines the access to the files. For details, see [Application File Directory and Application File Path](../../file-management/app-sandbox-directory.md#application-file-directory-and-application-file-path). > **NOTE** > diff --git a/en/application-dev/reference/apis-arkdata/js-apis-data-sendablePreferences.md b/en/application-dev/reference/apis-arkdata/js-apis-data-sendablePreferences.md index 201276a21a5..3d2adb2936f 100644 --- a/en/application-dev/reference/apis-arkdata/js-apis-data-sendablePreferences.md +++ b/en/application-dev/reference/apis-arkdata/js-apis-data-sendablePreferences.md @@ -5,7 +5,7 @@ The **sendablePreferences** module provides APIs for processing data in the form In the KV pairs, the key must be a string, and the value can be a number, a string, a Boolean value, a bigint, or a serializable object. -The persistent files of the shared user preferences are stored in the [preferencesDir](../../application-models/application-context-stage.md#obtaining-application-file-path) directory. Before creating a preferences object, ensure that the **preferencesDir** directory is readable and writeable. The [encryption level](../apis-ability-kit/js-apis-app-ability-contextConstant.md#areamode) of the persistent file directory determines the access to the files. For details, see [Application File Directory and Application File Path](../../file-management/app-sandbox-directory.md#application-file-directory-and-application-file-path). +The persistent files of the shared user preferences are stored in the [preferencesDir](../../application-models/application-context-stage.md#obtaining-application-file-paths) directory. Before creating a preferences object, ensure that the **preferencesDir** directory is readable and writeable. The [encryption level](../apis-ability-kit/js-apis-app-ability-contextConstant.md#areamode) of the persistent file directory determines the access to the files. For details, see [Application File Directory and Application File Path](../../file-management/app-sandbox-directory.md#application-file-directory-and-application-file-path). Sendable preferences can be passed between concurrent ArkTS instances (including the main thread and TaskPool or Worker threads) by reference. It allows for higher performance than [user preferences](js-apis-data-preferences.md). For more information, see [Using Sendable Objects](../../arkts-utils/sendable-guide.md). diff --git a/en/application-dev/reference/apis-arkdata/oh__predicates_8h.md b/en/application-dev/reference/apis-arkdata/oh__predicates_8h.md index 8270bc58177..57dbf1f5caa 100644 --- a/en/application-dev/reference/apis-arkdata/oh__predicates_8h.md +++ b/en/application-dev/reference/apis-arkdata/oh__predicates_8h.md @@ -36,4 +36,4 @@ Defines the predicates for RDB stores. | Name| Description| | -------- | -------- | -| [OH_OrderType](_r_d_b.md#oh_ordertype-1) { ASC = 0, DESC = 1 } | Enumerates the sorting types.| +| [OH_OrderType](_r_d_b.md#oh_ordertype) { ASC = 0, DESC = 1 } | Enumerates the sorting types.| diff --git a/en/application-dev/reference/apis-arkdata/union_rdb___key_info_1_1_rdb___key_data.md b/en/application-dev/reference/apis-arkdata/union_rdb___key_info_1_1_rdb___key_data.md index 5defb3f1147..27847d42c4b 100644 --- a/en/application-dev/reference/apis-arkdata/union_rdb___key_info_1_1_rdb___key_data.md +++ b/en/application-dev/reference/apis-arkdata/union_rdb___key_info_1_1_rdb___key_data.md @@ -9,8 +9,6 @@ Holds the changed data. **Related module**: [RDB](_r_d_b.md) -**Header file**: [relational_store.h](capi-relational-store-h.md) - ## Summary diff --git a/en/application-dev/reference/apis-arkdata/union_rdb___subscribe_callback.md b/en/application-dev/reference/apis-arkdata/union_rdb___subscribe_callback.md index 9a1294434f4..de7ba38f955 100644 --- a/en/application-dev/reference/apis-arkdata/union_rdb___subscribe_callback.md +++ b/en/application-dev/reference/apis-arkdata/union_rdb___subscribe_callback.md @@ -9,8 +9,6 @@ Defines the callback used to return the subscribed event. **Related module**: [RDB](_r_d_b.md) -**Header file**: [relational_store.h](capi-relational-store-h.md) - ## Summary diff --git a/en/application-dev/reference/apis-basic-services-kit/oh__pasteboard_8h.md b/en/application-dev/reference/apis-basic-services-kit/oh__pasteboard_8h.md index 2d9ba49792e..f68e12f2860 100644 --- a/en/application-dev/reference/apis-basic-services-kit/oh__pasteboard_8h.md +++ b/en/application-dev/reference/apis-basic-services-kit/oh__pasteboard_8h.md @@ -30,7 +30,7 @@ Provides data structure, enum types, and APIs for accessing the system pasteboar | typedef struct [OH_Pasteboard](_pasteboard.md#oh_pasteboard) [OH_Pasteboard](_pasteboard.md#oh_pasteboard) | Defines a struct for the pasteboard object to operate the system pasteboard. | | typedef enum [Pasteboard_FileConflictOptions](_pasteboard.md#pasteboard_fileconflictoptions) [Pasteboard_FileConflictOptions](_pasteboard.md#pasteboard_fileconflictoptions) | Defines an enum for options for file copy conflicts.| | typedef enum [Pasteboard_ProgressIndicator](_pasteboard.md#pasteboard_progressindicator) [Pasteboard_ProgressIndicator](_pasteboard.md#pasteboard_progressindicator) | Defines an enum for progress indicator display options. You can choose whether to use the default progress indicator.| -| typedef struct [Pasteboard_ProgressInfo](_pasteboard.md#pasteboard_progressinfo) [Pasteboard_ProgressInfo](_pasteboard.md#pasteboard_progressinfo) | Defines a struct for the progress information. This information is reported only when [Pasteboard_ProgressIndicator](#pasteboard_progressindicator) is set to [PASTEBOARD_NONE](_pasteboard.md).| +| typedef struct [Pasteboard_ProgressInfo](_pasteboard.md#pasteboard_progressinfo) [Pasteboard_ProgressInfo](_pasteboard.md#pasteboard_progressinfo) | Defines a struct for the progress information. This information is reported only when [Pasteboard_ProgressIndicator](_pasteboard.md#pasteboard_progressindicator) is set to [PASTEBOARD_NONE](_pasteboard.md).| | typedef void (* [OH_Pasteboard_ProgressListener](_pasteboard.md#oh_pasteboard_progresslistener))([Pasteboard_ProgressInfo](_pasteboard.md#pasteboard_progressinfo)* progressInfo) | Defines a callback function for obtaining the progress information. If the default progress indicator is not used, you can set this type to obtain the paste progress.| | typedef struct [Pasteboard_GetDataParams](_pasteboard.md#pasteboard_getdataparams) [Pasteboard_GetDataParams](_pasteboard.md#pasteboard_getdataparams) | Defines a struct for the pasteboard parameters required for displaying progress, including progress indicator options, destination path, and file conflict options.| -- Gitee