• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# OH_Predicates
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**起始版本：** 10
14
15**相关模块：** [RDB](capi-rdb.md)
16
17**所在头文件：** [oh_predicates.h](capi-oh-predicates-h.md)
18
19### 成员变量
20
21| 名称       | 描述                             |
22| ---------- | -------------------------------- |
23| int64_t id | H_Predicates结构体的唯一标识符。 |
24
25### 成员函数
26
27| 名称                                                         | 描述                                                         |
28| ------------------------------------------------------------ | ------------------------------------------------------------ |
29| [OH_Predicates *(*equalTo)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)](#equalto) | 函数指针，配置谓词以匹配数据字段等于指定值的字段。           |
30| [OH_Predicates *(*notEqualTo)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)](#notequalto) | 函数指针，配置谓词以匹配数据字段不等于指定值的字段。<br>该方法等同于SQL语句中的“!=”。 |
31| [OH_Predicates *(*beginWrap)(OH_Predicates *predicates)](#beginwrap) | 函数指针，向谓词添加左括号。<br>该方法等同于SQL语句中的“(”。 |
32| [OH_Predicates *(*endWrap)(OH_Predicates *predicates)](#endwrap) | 函数指针，向谓词添加右括号。<br>该方法等同于SQL语句中的“)”。 |
33| [OH_Predicates *(*orOperate)(OH_Predicates *predicates)](#oroperate) | 函数指针，将或条件添加到谓词中。<br>该方法等同于SQL语句中的“OR”。 |
34| [OH_Predicates *(*andOperate)(OH_Predicates *predicates)](#andoperate) | 函数指针，向谓词添加和条件。<br>该方法等同于SQL语句中的“AND”。 |
35| [OH_Predicates *(*isNull)(OH_Predicates *predicates, const char *field)](#isnull) | 函数指针，配置谓词以匹配值为null的字段。<br>该方法等同于SQL语句中的“IS NULL”。 |
36| [OH_Predicates *(*isNotNull)(OH_Predicates *predicates, const char *field)](#isnotnull) | 函数指针，配置谓词以匹配值不为null的指定字段。<br>该方法等同于SQL语句中的“IS NOT NULL”。 |
37| [OH_Predicates *(*like)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)](#like) | 函数指针，配置谓词以匹配数据字段为field且值类似于指定字符串的字段。<br>该方法等同于SQL语句中的“LIKE”。 |
38| [OH_Predicates *(*between)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)](#between) | 函数指针，将谓词配置为匹配数据字段为field且其值在给定范围内的指定字段。<br>该方法等同于SQL语句中的“BETWEEN”。 |
39| [OH_Predicates *(*notBetween)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)](#notbetween) | 函数指针，将谓词配置为匹配数据字段为field且其值超出给定范围内的指定字段。<br>该方法等同于SQL语句中的“NOT BETWEEN”。 |
40| [OH_Predicates *(*greaterThan)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)](#greaterthan) | 函数指针，配置谓词以匹配数据字段为field且值大于指定值valueObject的字段。<br>该方法等同于SQL语句中的“>”。 |
41| [OH_Predicates *(*lessThan)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)](#lessthan) | 函数指针，配置谓词以匹配数据字段为field且值小于指定值valueObject的字段。<br>该方法等同于SQL语句中的“<”。 |
42| [OH_Predicates *(*greaterThanOrEqualTo)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)](#greaterthanorequalto) | 函数指针，配置谓词以匹配数据字段为field且值大于或等于指定值valueObject的字段。<br>该方法等同于SQL语句中的“>=”。 |
43| [OH_Predicates *(*lessThanOrEqualTo)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)](#lessthanorequalto) | 函数指针，配置谓词以匹配数据字段为field且值小于或等于指定值valueObject的字段。<br>该方法等同于SQL语句中的“<=”。 |
44| [OH_Predicates *(*orderBy)(OH_Predicates *predicates, const char *field, OH_OrderType type)](#orderby) | 函数指针，配置谓词以匹配其值按升序或降序排序的列。<br>该方法等同于SQL语句中的“ORDER BY”。 |
45| [OH_Predicates *(*distinct)(OH_Predicates *predicates)](#distinct) | 函数指针，配置谓词以过滤重复记录并仅保留其中一个。<br>该方法等同于SQL语句中的“DISTINCT”。 |
46| [OH_Predicates *(*limit)(OH_Predicates *predicates, unsigned int value)](#limit) | 函数指针，设置最大数据记录数的谓词。<br>该方法等同于SQL语句中的“LIMIT”。 |
47| [OH_Predicates *(*offset)(OH_Predicates *predicates, unsigned int rowOffset)](#offset) | 函数指针，配置谓词以指定返回结果的起始位置。<br>该方法等同于SQL语句中的“OFFSET”。 |
48| [OH_Predicates *(*groupBy)(OH_Predicates *predicates, char const *const *fields, int length)](#groupby) | 函数指针，配置R谓词按指定列分组查询结果。<br>该方法等同于SQL语句中的“GROUP BY”。 |
49| [OH_Predicates *(*in)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)](#in) | 函数指针，配置谓词以匹配数据字段为field且值在给定范围内的指定字段。<br>该方法等同于SQL语句中的“IN”。 |
50| [OH_Predicates *(*notIn)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)](#notin) | 函数指针，配置谓词以匹配数据字段为field且值超出给定范围内的指定字段。<br>该方法等同于SQL语句中的“NOT IN”。 |
51| [OH_Predicates *(*clear)(OH_Predicates *predicates)](#clear) | 函数指针，清空谓词。                                         |
52| [int (*destroy)(OH_Predicates *predicates)](#destroy)        | 销毁OH_Predicates对象，并回收该对象占用的内存。              |
53
54
55## 成员函数说明
56
57### equalTo()
58
59```
60OH_Predicates *(*equalTo)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
61```
62
63**描述**
64
65函数指针，配置谓词以匹配数据字段等于指定值的字段。
66
67**起始版本：** 10
68
69**参数：**
70
71| 参数项                    | 描述                                                         |
72| ------------------------- | ------------------------------------------------------------ |
73| OH_Predicates *predicates | 表示指向OH_Predicates实例的指针。                            |
74| const char *field         | 数据库表中的列名                                             |
75| [OH_VObject](capi-rdb-oh-vobject.md) *valueObject   | 表示指向[OH_VObject](capi-rdb-oh-vobject.md)实例的指针，指示要与谓词匹配的值。 |
76
77**返回：**
78
79| 类型            | 说明                       |
80| --------------- | -------------------------- |
81| OH_Predicates * | 返回与指定字段匹配的谓词。 |
82
83### notEqualTo()
84
85```
86OH_Predicates *(*notEqualTo)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
87```
88
89**描述**
90
91函数指针，配置谓词以匹配数据字段不等于指定值的字段。<br>该方法等同于SQL语句中的“!=”。
92
93**起始版本：** 10
94
95**参数：**
96
97| 参数项                                        | 描述                                                         |
98| --------------------------------------------- | ------------------------------------------------------------ |
99| OH_Predicates *predicates                     | 表示指向OH_Predicates实例的指针。                            |
100| const char *field                             | 数据库表中的列名。                                           |
101| [OH_VObject](capi-rdb-oh-vobject.md) *valueObject | 表示指向[OH_VObject](capi-rdb-oh-vobject.md)实例的指针，指示要与谓词匹配的值。 |
102
103**返回：**
104
105| 类型            | 说明                       |
106| --------------- | -------------------------- |
107| OH_Predicates * | 返回与指定字段匹配的谓词。 |
108
109### beginWrap()
110
111```
112OH_Predicates *(*beginWrap)(OH_Predicates *predicates)
113```
114
115**描述**
116
117函数指针，向谓词添加左括号。<br>该方法等同于SQL语句中的“(”。
118
119**起始版本：** 10
120
121**参数：**
122
123| 参数项                   | 描述                              |
124| ------------------------ | --------------------------------- |
125| OH_Predicates *predicates | 表示指向OH_Predicates实例的指针。 |
126
127**返回：**
128
129| 类型            | 说明                   |
130| --------------- | ---------------------- |
131| OH_Predicates * | 返回带有左括号的谓词。 |
132
133### endWrap()
134
135```
136OH_Predicates *(*endWrap)(OH_Predicates *predicates)
137```
138
139**描述**
140
141函数指针，向谓词添加右括号。<br>该方法等同于SQL语句中的“)”。
142
143**起始版本：** 10
144
145**参数：**
146
147| 参数项                    | 描述                              |
148| ------------------------- | --------------------------------- |
149| OH_Predicates *predicates | 表示指向OH_Predicates实例的指针。 |
150
151**返回：**
152
153| 类型            | 说明                   |
154| --------------- | ---------------------- |
155| OH_Predicates * | 返回带有右括号的谓词。 |
156
157### orOperate()
158
159```
160OH_Predicates *(*orOperate)(OH_Predicates *predicates)
161```
162
163**描述**
164
165函数指针，将或条件添加到谓词中。<br>该方法等同于SQL语句中的“OR”。
166
167**起始版本：** 10
168
169**参数：**
170
171| 参数项                    | 描述                              |
172| ------------------------- | --------------------------------- |
173| OH_Predicates *predicates | 表示指向OH_Predicates实例的指针。 |
174
175**返回：**
176
177| 类型            | 说明                   |
178| --------------- | ---------------------- |
179| OH_Predicates * | 返回带有或条件的谓词。 |
180
181### andOperate()
182
183```
184OH_Predicates *(*andOperate)(OH_Predicates *predicates)
185```
186
187**描述**
188
189函数指针，向谓词添加和条件。<br>该方法等同于SQL语句中的“AND”。
190
191**起始版本：** 10
192
193**参数：**
194
195| 参数项                    | 描述                              |
196| ------------------------- | --------------------------------- |
197| OH_Predicates *predicates | 表示指向OH_Predicates实例的指针。 |
198
199**返回：**
200
201| 类型            | 说明                   |
202| --------------- | ---------------------- |
203| OH_Predicates * | 返回带有和条件的谓词。 |
204
205### isNull()
206
207```
208OH_Predicates *(*isNull)(OH_Predicates *predicates, const char *field)
209```
210
211**描述**
212
213函数指针，配置谓词以匹配值为null的字段。<br>该方法等同于SQL语句中的“IS NULL”。
214
215**起始版本：** 10
216
217**参数：**
218
219| 参数项                    | 描述                              |
220| ------------------------- | --------------------------------- |
221| OH_Predicates *predicates | 表示指向OH_Predicates实例的指针。 |
222| const char *field         | 数据库表中的列名。                |
223
224**返回：**
225
226| 类型            | 说明                       |
227| --------------- | -------------------------- |
228| OH_Predicates * | 返回与指定字段匹配的谓词。 |
229
230### isNotNull()
231
232```
233OH_Predicates *(*isNotNull)(OH_Predicates *predicates, const char *field)
234```
235
236**描述**
237
238函数指针，配置谓词以匹配值不为null的指定字段。<br>该方法等同于SQL语句中的“IS NOT NULL”。
239
240**起始版本：** 10
241
242**参数：**
243
244| 参数项                    | 描述                              |
245| ------------------------- | --------------------------------- |
246| OH_Predicates *predicates | 表示指向OH_Predicates实例的指针。 |
247| const char *field         | 数据库表中的列名。                |
248
249**返回：**
250
251| 类型            | 说明                       |
252| --------------- | -------------------------- |
253| OH_Predicates * | 返回与指定字段匹配的谓词。 |
254
255### like()
256
257```
258OH_Predicates *(*like)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
259```
260
261**描述**
262
263函数指针，配置谓词以匹配数据字段为field且值类似于指定字符串的字段。<br>该方法等同于SQL语句中的“LIKE”。
264
265**起始版本：** 10
266
267**参数：**
268
269| 参数项                                        | 描述                                                         |
270| --------------------------------------------- | ------------------------------------------------------------ |
271| OH_Predicates *predicates                     | 表示指向OH_Predicates实例的指针。                            |
272| const char *field                             | 数据库表中的列名。                                           |
273| [OH_VObject](capi-rdb-oh-vobject.md) *valueObject | 表示指向[OH_VObject](capi-rdb-oh-vobject.md)实例的指针，指示要与谓词匹配的值。 |
274
275**返回：**
276
277| 类型            | 说明                       |
278| --------------- | -------------------------- |
279| OH_Predicates * | 返回与指定字段匹配的谓词。 |
280
281
282### between()
283
284```
285OH_Predicates *(*between)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
286```
287
288**描述**
289
290函数指针，将谓词配置为匹配数据字段为field且其值在给定范围内的指定字段。<br>该方法等同于SQL语句中的“BETWEEN”。
291
292**起始版本：** 10
293
294**参数：**
295
296| 参数项                                        | 描述                                                         |
297| --------------------------------------------- | ------------------------------------------------------------ |
298| OH_Predicates *predicates                     | 表示指向OH_Predicates实例的指针。                            |
299| const char *field                             | 数据库表中的列名。                                           |
300| [OH_VObject](capi-rdb-oh-vobject.md) *valueObject | 表示指向[OH_VObject](capi-rdb-oh-vobject.md)实例的指针，指示要与谓词匹配的值。 |
301
302**返回：**
303
304| 类型            | 说明                       |
305| --------------- | -------------------------- |
306| OH_Predicates * | 返回与指定字段匹配的谓词。 |
307
308### notBetween()
309
310```
311OH_Predicates *(*notBetween)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
312```
313
314**描述**
315
316函数指针，将谓词配置为匹配数据字段为field且其值超出给定范围内的指定字段。<br>该方法等同于SQL语句中的“NOT BETWEEN”。
317
318**起始版本：** 10
319
320**参数：**
321
322| 参数项                                        | 描述                                                         |
323| --------------------------------------------- | ------------------------------------------------------------ |
324| OH_Predicates *predicates                     | 表示指向OH_Predicates实例的指针。                            |
325| const char *field                             | 数据库表中的列名。                                           |
326| [OH_VObject](capi-rdb-oh-vobject.md) *valueObject | 表示指向[OH_VObject](capi-rdb-oh-vobject.md)实例的指针，指示要与谓词匹配的值。 |
327
328**返回：**
329
330| 类型            | 说明                       |
331| --------------- | -------------------------- |
332| OH_Predicates * | 返回与指定字段匹配的谓词。 |
333
334### greaterThan()
335
336```
337OH_Predicates *(*greaterThan)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
338```
339
340**描述**
341
342函数指针，配置谓词以匹配数据字段为field且值大于指定值valueObject的字段。<br>该方法等同于SQL语句中的“>”。
343
344**起始版本：** 10
345
346**参数：**
347
348| 参数项                                        | 描述                                                         |
349| --------------------------------------------- | ------------------------------------------------------------ |
350| OH_Predicates *predicates                     | 表示指向OH_Predicates实例的指针。                            |
351| const char *field                             | 数据库表中的列名。                                           |
352| [OH_VObject](capi-rdb-oh-vobject.md) *valueObject | 表示指向[OH_VObject](capi-rdb-oh-vobject.md)实例的指针，指示要与谓词匹配的值。 |
353
354**返回：**
355
356| 类型            | 说明                       |
357| --------------- | -------------------------- |
358| OH_Predicates * | 返回与指定字段匹配的谓词。 |
359
360### lessThan()
361
362```
363OH_Predicates *(*lessThan)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
364```
365
366**描述**
367
368函数指针，配置谓词以匹配数据字段为field且值小于指定值valueObject的字段。<br>该方法等同于SQL语句中的“<”。
369
370**起始版本：** 10
371
372**参数：**
373
374| 参数项                                        | 描述                                                         |
375| --------------------------------------------- | ------------------------------------------------------------ |
376| OH_Predicates *predicates                     | 表示指向OH_Predicates实例的指针。                            |
377| const char *field                             | 数据库表中的列名。                                           |
378| [OH_VObject](capi-rdb-oh-vobject.md) *valueObject | 表示指向[OH_VObject](capi-rdb-oh-vobject.md)实例的指针，指示要与谓词匹配的值。 |
379
380**返回：**
381
382| 类型            | 说明                       |
383| --------------- | -------------------------- |
384| OH_Predicates * | 返回与指定字段匹配的谓词。 |
385
386### greaterThanOrEqualTo()
387
388```
389OH_Predicates *(*greaterThanOrEqualTo)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
390```
391
392**描述**
393
394函数指针，配置谓词以匹配数据字段为field且值大于或等于指定值valueObject的字段。<br>该方法等同于SQL语句中的“>=”。
395
396**起始版本：** 10
397
398**参数：**
399
400| 参数项                                        | 描述                                                         |
401| --------------------------------------------- | ------------------------------------------------------------ |
402| OH_Predicates *predicates                     | 表示指向OH_Predicates实例的指针。                            |
403| const char *field                             | 数据库表中的列名。                                           |
404| [OH_VObject](capi-rdb-oh-vobject.md) *valueObject | 表示指向[OH_VObject](capi-rdb-oh-vobject.md)实例的指针，指示要与谓词匹配的值。 |
405
406**返回：**
407
408| 类型            | 说明                       |
409| --------------- | -------------------------- |
410| OH_Predicates * | 返回与指定字段匹配的谓词。 |
411
412### lessThanOrEqualTo()
413
414```
415OH_Predicates *(*lessThanOrEqualTo)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
416```
417
418**描述**
419
420函数指针，配置谓词以匹配数据字段为field且值小于或等于指定值valueObject的字段。<br>该方法等同于SQL语句中的“<=”。
421
422**起始版本：** 10
423
424**参数：**
425
426| 参数项                    | 描述                                                         |
427| ------------------------- | ------------------------------------------------------------ |
428| OH_Predicates *predicates | 表示指向OH_Predicates实例的指针。                            |
429| const char *field         | 数据库表中的列名。                                           |
430| OH_VObject *valueObject   | 表示指向[OH_VObject](capi-rdb-oh-vobject.md)实例的指针，指示要与谓词匹配的值。 |
431
432**返回：**
433
434| 类型            | 说明                       |
435| --------------- | -------------------------- |
436| OH_Predicates * | 返回与指定字段匹配的谓词。 |
437
438### orderBy()
439
440```
441OH_Predicates *(*orderBy)(OH_Predicates *predicates, const char *field, OH_OrderType type)
442```
443
444**描述**
445
446函数指针，配置谓词以匹配其值按升序或降序排序的列。<br>该方法等同于SQL语句中的“ORDER BY”。
447
448**起始版本：** 10
449
450**参数：**
451
452| 参数项                                | 描述                                           |
453| ------------------------------------- | ---------------------------------------------- |
454| OH_Predicates *predicates             | 表示指向OH_Predicates实例的指针。              |
455| const char *field                     | 数据库表中的列名。                             |
456| [OH_VObject](capi-rdb-oh-vobject.md) type | 表示排序类型[OH_VObject](capi-rdb-oh-vobject.md)。 |
457
458**返回：**
459
460| 类型            | 说明                       |
461| --------------- | -------------------------- |
462| OH_Predicates * | 返回与指定字段匹配的谓词。 |
463
464### distinct()
465
466```
467OH_Predicates *(*distinct)(OH_Predicates *predicates)
468```
469
470**描述**
471
472函数指针，配置谓词以过滤重复记录并仅保留其中一个。<br>该方法等同于SQL语句中的“DISTINCT”。
473
474**起始版本：** 10
475
476**参数：**
477
478| 参数项                    | 描述                              |
479| ------------------------- | --------------------------------- |
480| OH_Predicates *predicates | 表示指向OH_Predicates实例的指针。 |
481
482**返回：**
483
484| 类型            | 说明                           |
485| --------------- | ------------------------------ |
486| OH_Predicates * | 返回可用于过滤重复记录的谓词。 |
487
488### limit()
489
490```
491OH_Predicates *(*limit)(OH_Predicates *predicates, unsigned int value)
492```
493
494**描述**
495
496函数指针，设置最大数据记录数的谓词。<br>该方法等同于SQL语句中的“LIMIT”。
497
498**起始版本：** 10
499
500**参数：**
501
502| 参数项                    | 描述                              |
503| ------------------------- | --------------------------------- |
504| OH_Predicates *predicates | 表示指向OH_Predicates实例的指针。 |
505| unsigned int value        | 表示最大数据记录数。              |
506
507**返回：**
508
509| 类型            | 说明                                 |
510| --------------- | ------------------------------------ |
511| OH_Predicates * | 返回可用于设置最大数据记录数的谓词。 |
512
513### offset()
514
515```
516OH_Predicates *(*offset)(OH_Predicates *predicates, unsigned int rowOffset)
517```
518
519**描述**
520
521函数指针，配置谓词以指定返回结果的起始位置。<br>该方法等同于SQL语句中的“OFFSET”。
522
523**起始版本：** 10
524
525**参数：**
526
527| 参数项                    | 描述                               |
528| ------------------------- | ---------------------------------- |
529| OH_Predicates *predicates | 表示指向OH_Predicates实例的指针。  |
530| unsigned int rowOffset    | 返回结果的起始位置，取值为正整数。 |
531
532**返回：**
533
534| 类型            | 说明                                 |
535| --------------- | ------------------------------------ |
536| OH_Predicates * | 返回具有指定返回结果起始位置的谓词。 |
537
538### groupBy()
539
540```
541OH_Predicates *(*groupBy)(OH_Predicates *predicates, char const *const *fields, int length)
542```
543
544**描述**
545
546函数指针，配置R谓词按指定列分组查询结果。<br>该方法等同于SQL语句中的“GROUP BY”。
547
548**起始版本：** 10
549
550**参数：**
551
552| 参数项                    | 描述                                                 |
553| ------------------------- | ---------------------------------------------------- |
554| OH_Predicates *predicates | 表示指向OH_Predicates实例的指针。                    |
555| char const *const *fields | 指定分组依赖的列名。                                 |
556| int length                | 该参数为输入参数，表示开发者传入的fields数值的长度。 |
557
558**返回：**
559
560| 类型            | 说明                   |
561| --------------- | ---------------------- |
562| OH_Predicates * | 返回分组查询列的谓词。 |
563
564### in()
565
566```
567OH_Predicates *(*in)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
568```
569
570**描述**
571
572函数指针，配置谓词以匹配数据字段为field且值在给定范围内的指定字段。<br>该方法等同于SQL语句中的“IN”。
573
574**起始版本：** 10
575
576**参数：**
577
578| 参数项                                        | 描述                                                         |
579| --------------------------------------------- | ------------------------------------------------------------ |
580| OH_Predicates *predicates                     | 表示指向OH_Predicates实例的指针。                            |
581| const char *field                             | 表示数据库表中的列名。                                       |
582| [OH_VObject](capi-rdb-oh-vobject.md) *valueObject | 表示指向[OH_VObject](capi-rdb-oh-vobject.md)实例的指针，指示要与谓词匹配的值。 |
583
584**返回：**
585
586| 类型            | 说明                       |
587| --------------- | -------------------------- |
588| OH_Predicates * | 返回与指定字段匹配的谓词。 |
589
590### notIn()
591
592```
593OH_Predicates *(*notIn)(OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
594```
595
596**描述**
597
598函数指针，配置谓词以匹配数据字段为field且值超出给定范围内的指定字段。<br>该方法等同于SQL语句中的“NOT IN”。
599
600**起始版本：** 10
601
602**参数：**
603
604| 参数项                                        | 描述                                                         |
605| --------------------------------------------- | ------------------------------------------------------------ |
606| OH_Predicates *predicates                     | 表示指向OH_Predicates实例的指针。                            |
607| const char *field                             | 表示数据库表中的列名。                                       |
608| [OH_VObject](capi-rdb-oh-vobject.md) *valueObject | 表示指向[OH_VObject](capi-rdb-oh-vobject.md)实例的指针，指示要与谓词匹配的值。 |
609
610**返回：**
611
612| 类型            | 说明                       |
613| --------------- | -------------------------- |
614| OH_Predicates * | 返回与指定字段匹配的谓词。 |
615
616### clear()
617
618```
619OH_Predicates *(*clear)(OH_Predicates *predicates)
620```
621
622**描述**
623
624函数指针，清空谓词。
625
626**起始版本：** 10
627
628**参数：**
629
630| 参数项                    | 描述                              |
631| ------------------------- | --------------------------------- |
632| OH_Predicates *predicates | 表示指向OH_Predicates实例的指针。 |
633
634**返回：**
635
636| 类型            | 说明               |
637| --------------- | ------------------ |
638| OH_Predicates * | 返回清空后的谓词。 |
639
640### destroy()
641
642```
643int (*destroy)(OH_Predicates *predicates)
644```
645
646**描述**
647
648销毁OH_Predicates对象，并回收该对象占用的内存。
649
650**起始版本：** 10
651
652**参数：**
653
654| 参数项                    | 描述                              |
655| ------------------------- | --------------------------------- |
656| OH_Predicates *predicates | 表示指向OH_Predicates实例的指针。 |
657
658**返回：**
659
660| 类型 | 说明                                       |
661| ---- | ------------------------------------------ |
662| int  | 返回操作是否成功，出错时返回对应的错误码。 |
663
664
665
666
667
668
669
670