• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# oh_data_values_buckets.h
2<!--Kit: ArkData-->
3<!--Subsystem: DistributedDataManager-->
4<!--Owner: @baijidong-->
5<!--Designer: @widecode; @htt1997-->
6<!--Tester: @yippo; @logic42-->
7<!--Adviser: @ge-yafang-->
8
9## 概述
10
11提供与存储数据值相关的结构定义、函数和枚举。
12
13**引用文件:** <database/rdb/oh_data_values_buckets.h>
14
15**库:** libnative_rdb_ndk.z.so
16
17**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
18
19**起始版本:** 18
20
21**相关模块:** [RDB](capi-rdb.md)
22
23## 汇总
24
25### 结构体
26
27| 名称                                         | typedef关键字    | 描述                           |
28| -------------------------------------------- | ---------------- | ------------------------------ |
29| [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) | OH_Data_VBuckets | 定义OH_Data_VBuckets结构类型。 |
30
31### 函数
32
33| 名称                                                         | 描述                                     |
34| ------------------------------------------------------------ | ---------------------------------------- |
35| [OH_Data_VBuckets *OH_VBuckets_Create(void)](#oh_vbuckets_create) | 创建OH_Data_VBuckets实例。               |
36| [int OH_VBuckets_Destroy(OH_Data_VBuckets *buckets)](#oh_vbuckets_destroy) | 销毁OH_Data_VBuckets对象。               |
37| [int OH_VBuckets_PutRow(OH_Data_VBuckets *buckets, const OH_VBucket *row)](#oh_vbuckets_putrow) | 添加OH_VBucket类型数据。                 |
38| [int OH_VBuckets_PutRows(OH_Data_VBuckets *buckets, const OH_Data_VBuckets *rows)](#oh_vbuckets_putrows) | 添加OH_Data_VBuckets类型数据。           |
39| [int OH_VBuckets_RowCount(OH_Data_VBuckets *buckets, size_t *count)](#oh_vbuckets_rowcount) | 获取OH_Data_VBuckets中OH_VBucket的行数。 |
40
41## 函数说明
42
43### OH_VBuckets_Create()
44
45```
46OH_Data_VBuckets *OH_VBuckets_Create(void)
47```
48
49**描述**
50
51创建OH_Data_VBuckets实例。
52
53**起始版本:** 18
54
55**返回:**
56
57| 类型                                         | 说明                                                         |
58| -------------------------------------------- | ------------------------------------------------------------ |
59| [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) | 执行成功时返回指向[OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md)实例的指针。否则返回nullptr。<br>使用完成后,必须通过[OH_VBuckets_Destroy](capi-oh-data-values-buckets-h.md#oh_vbuckets_destroy)接口释放内存。 |
60
61### OH_VBuckets_Destroy()
62
63```
64int OH_VBuckets_Destroy(OH_Data_VBuckets *buckets)
65```
66
67**描述**
68
69销毁OH_Data_VBuckets对象。
70
71**起始版本:** 18
72
73
74**参数:**
75
76| 参数项                                                | 描述                                                         |
77| ----------------------------------------------------- | ------------------------------------------------------------ |
78| [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) *buckets | 表示指向[OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md)实例的指针。 |
79
80**返回:**
81
82| 类型 | 说明                                                         |
83| ---- | ------------------------------------------------------------ |
84| int  | 返回错误码。<br>返回RDB_OK表示成功。<br>返回RDB_E_INVALID_ARGS表示无效参数。 |
85
86### OH_VBuckets_PutRow()
87
88```
89int OH_VBuckets_PutRow(OH_Data_VBuckets *buckets, const OH_VBucket *row)
90```
91
92**描述**
93
94添加OH_VBucket类型数据。
95
96**起始版本:** 18
97
98
99**参数:**
100
101| 参数项                                                | 描述                                                         |
102| ----------------------------------------------------- | ------------------------------------------------------------ |
103| [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) *buckets | 表示指向[OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md)实例的指针。 |
104| const [OH_VBucket](capi-rdb-oh-vbucket.md) *row           | 表示指向[OH_VBucket](capi-rdb-oh-vbucket.md)实例的指针。         |
105
106**返回:**
107
108| 类型 | 说明                                                         |
109| ---- | ------------------------------------------------------------ |
110| int  | 返回错误码。<br>返回RDB_OK表示成功。<br>返回RDB_E_INVALID_ARGS表示无效参数。 |
111
112### OH_VBuckets_PutRows()
113
114```
115int OH_VBuckets_PutRows(OH_Data_VBuckets *buckets, const OH_Data_VBuckets *rows)
116```
117
118**描述**
119
120添加OH_Data_VBuckets类型数据。
121
122**起始版本:** 18
123
124
125**参数:**
126
127| 参数项                                                   | 描述                                                         |
128| -------------------------------------------------------- | ------------------------------------------------------------ |
129| [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) *buckets    | 表示指向[OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md)实例的指针。 |
130| const [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) *rows | 表示指向[OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md)实例的指针。 |
131
132**返回:**
133
134| 类型 | 说明                                                         |
135| ---- | ------------------------------------------------------------ |
136| int  | 返回错误码。<br>返回RDB_OK表示成功。<br>返回RDB_E_INVALID_ARGS表示无效参数。 |
137
138### OH_VBuckets_RowCount()
139
140```
141int OH_VBuckets_RowCount(OH_Data_VBuckets *buckets, size_t *count)
142```
143
144**描述**
145
146获取OH_Data_VBuckets中OH_VBucket的行数。
147
148**起始版本:** 18
149
150
151**参数:**
152
153| 参数项                                                | 描述                                                         |
154| ----------------------------------------------------- | ------------------------------------------------------------ |
155| [OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md) *buckets | 表示指向[OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md)实例的指针。 |
156| size_t *count                                         | 一个输出参数,表示[OH_Data_VBuckets](capi-rdb-oh-data-vbuckets.md)中[OH_VBucket](capi-rdb-oh-vbucket.md)的个数。 |
157
158**返回:**
159
160| 类型 | 说明                                                         |
161| ---- | ------------------------------------------------------------ |
162| int  | 返回错误码。<br>返回RDB_OK表示成功。<br>返回RDB_E_INVALID_ARGS表示无效参数。 |
163
164