File: grn_info.rst

package info (click to toggle)
groonga 9.0.0-1%2Bdeb10u1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 101,496 kB
  • sloc: ansic: 608,707; ruby: 35,042; xml: 23,643; cpp: 10,319; sh: 7,453; yacc: 5,968; python: 3,033; makefile: 2,609; perl: 133
file content (56 lines) | stat: -rw-r--r-- 1,895 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
.. -*- rst -*-

.. highlightlang:: none

``grn_info``
============

Summary
-------

TODO...

Example
-------

TODO...

Reference
---------

.. c:type:: grn_info_type

   TODO...

.. c:function:: grn_obj *grn_obj_get_info(grn_ctx *ctx, grn_obj *obj, grn_info_type type, grn_obj *valuebuf)

   objのtypeに対応する情報をvaluebufに格納します。

   :param obj: 対象objを指定します。
   :param type: 取得する情報の種類を指定します。
   :param valuebuf: 値を格納するバッファ(呼出側で準備)を指定します。

.. c:function:: grn_rc grn_obj_set_info(grn_ctx *ctx, grn_obj *obj, grn_info_type type, grn_obj *value)

   objのtypeに対応する情報をvalueの内容に更新します。

   :param obj: 対象objを指定します。
   :param type: 設定する情報の種類を指定します。

.. c:function:: grn_obj *grn_obj_get_element_info(grn_ctx *ctx, grn_obj *obj, grn_id id, grn_info_type type, grn_obj *value)

   objのidに対応するレコードの、typeに対応する情報をvaluebufに格納します。呼出側ではtypeに応じて十分なサイズのバッファを確保しなければいけません。

   :param obj: 対象objを指定します。
   :param id: 対象IDを指定します。
   :param type: 取得する情報の種類を指定します。
   :param value: 値を格納するバッファ(呼出側で準備)を指定します。

.. c:function:: grn_rc grn_obj_set_element_info(grn_ctx *ctx, grn_obj *obj, grn_id id, grn_info_type type, grn_obj *value)

   objのidに対応するレコードのtypeに対応する情報をvalueの内容に更新します。

   :param obj: 対象objectを指定します。
   :param id: 対象IDを指定します。
   :param type: 設定する情報の種類を指定します。
   :param value: 設定しようとする値を指定します。