1# oh_data_values_buckets.h 2 3## Overview 4 5Defines structs, APIs, and enums related to stored data values. 6 7**File to include**: <database/rdb/oh_data_values_buckets.h> 8 9**Library**: libnative_rdb_ndk.z.so 10 11**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core 12 13**Since**: 18 14 15**Related module**: [RDB](capi-rdb.md) 16 17## Summary 18 19### Structs 20 21| Name | typedef Keyword | Description | 22| -------------------------------------------- | ---------------- | ------------------------------ | 23| [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) | OH_Data_VBuckets | Defines the **OH_Data_VBuckets** struct.| 24 25### Functions 26 27| Name | Description | 28| ------------------------------------------------------------ | ---------------------------------------- | 29| [OH_Data_VBuckets *OH_VBuckets_Create(void)](#oh_vbuckets_create) | Creates an **OH_Data_VBuckets** instance. | 30| [int OH_VBuckets_Destroy(OH_Data_VBuckets *buckets)](#oh_vbuckets_destroy) | Destroys an **OH_Data_VBuckets** instance. | 31| [int OH_VBuckets_PutRow(OH_Data_VBuckets *buckets, const OH_VBucket *row)](#oh_vbuckets_putrow) | Adds data of the **OH_VBucket** type to an **OH_Data_VBuckets** instance. | 32| [int OH_VBuckets_PutRows(OH_Data_VBuckets *buckets, const OH_Data_VBuckets *rows)](#oh_vbuckets_putrows) | Adds data of the **OH_Data_VBuckets** type to an **OH_Data_VBuckets** instance. | 33| [int OH_VBuckets_RowCount(OH_Data_VBuckets *buckets, size_t *count)](#oh_vbuckets_rowcount) | Obtains the number of **OH_VBucket**s in an **OH_Data_VBuckets** instance.| 34 35## Function Description 36 37### OH_VBuckets_Create() 38 39``` 40OH_Data_VBuckets *OH_VBuckets_Create(void) 41``` 42 43**Description** 44 45Creates an **OH_Data_VBuckets** instance. 46 47**Since**: 18 48 49**Returns** 50 51| Type | Description | 52| -------------------------------------------- | ------------------------------------------------------------ | 53| [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) | Returns a pointer to the [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) instance if the operation is successful; returns **nullptr** otherwise.<br>Use [OH_VBuckets_Destroy](capi-oh-data-values-buckets-h.md#oh_vbuckets_destroy) to release the memory in time.| 54 55### OH_VBuckets_Destroy() 56 57``` 58int OH_VBuckets_Destroy(OH_Data_VBuckets *buckets) 59``` 60 61**Description** 62 63Destroys an **OH_Data_VBuckets** instance. 64 65**Since**: 18 66 67 68**Parameters** 69 70| Name | Description | 71| ----------------------------------------------------- | ------------------------------------------------------------ | 72| [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) *buckets | Pointer to the [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) instance.| 73 74**Returns** 75 76| Type| Description | 77| ---- | ------------------------------------------------------------ | 78| int | Returns an error code.<br>**RDB_OK** indicates the operation is successful.<br>**RDB_E_INVALID_ARGS** indicates that invalid parameters are specified.| 79 80### OH_VBuckets_PutRow() 81 82``` 83int OH_VBuckets_PutRow(OH_Data_VBuckets *buckets, const OH_VBucket *row) 84``` 85 86**Description** 87 88Adds data of the **OH_VBucket** type to an **OH_Data_VBuckets** instance. 89 90**Since**: 18 91 92 93**Parameters** 94 95| Name | Description | 96| ----------------------------------------------------- | ------------------------------------------------------------ | 97| [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) *buckets | Pointer to the [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) instance.| 98| const [OH_VBucket](capi-rdb-oh-vbucket.md) *row | Pointer to the [OH_VBucket](capi-rdb-oh-vbucket.md) instance. | 99 100**Returns** 101 102| Type| Description | 103| ---- | ------------------------------------------------------------ | 104| int | Returns an error code.<br>**RDB_OK** indicates the operation is successful.<br>**RDB_E_INVALID_ARGS** indicates that invalid parameters are specified.| 105 106### OH_VBuckets_PutRows() 107 108``` 109int OH_VBuckets_PutRows(OH_Data_VBuckets *buckets, const OH_Data_VBuckets *rows) 110``` 111 112**Description** 113 114Adds data of the **OH_Data_VBuckets** type to an **OH_Data_VBuckets** instance. 115 116**Since**: 18 117 118 119**Parameters** 120 121| Name | Description | 122| -------------------------------------------------------- | ------------------------------------------------------------ | 123| [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) *buckets | Pointer to the [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) instance.| 124| const [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) *rows | Pointer to the [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) instance.| 125 126**Returns** 127 128| Type| Description | 129| ---- | ------------------------------------------------------------ | 130| int | Returns an error code.<br>**RDB_OK** indicates the operation is successful.<br>**RDB_E_INVALID_ARGS** indicates that invalid parameters are specified.| 131 132### OH_VBuckets_RowCount() 133 134``` 135int OH_VBuckets_RowCount(OH_Data_VBuckets *buckets, size_t *count) 136``` 137 138**Description** 139 140Obtains the number of **OH_VBucket**s in an **OH_Data_VBuckets** instance. 141 142**Since**: 18 143 144 145**Parameters** 146 147| Name | Description | 148| ----------------------------------------------------- | ------------------------------------------------------------ | 149| [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) *buckets | Pointer to the [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) instance.| 150| size_t *count | Pointer to the number of [OH_VBucket](capi-rdb-oh-vbucket.md)s in an [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) instance.| 151 152**Returns** 153 154| Type| Description | 155| ---- | ------------------------------------------------------------ | 156| int | Returns an error code.<br>**RDB_OK** indicates the operation is successful.<br>**RDB_E_INVALID_ARGS** indicates that invalid parameters are specified.| 157