File: grn_proc.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-- 2,006 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_proc``
============

Summary
-------

TODO...

Example
-------

TODO...

Reference
---------

.. c:type:: grn_proc_type

   TODO...

.. c:type:: grn_proc_func

   TODO...

.. c:function:: grn_obj *grn_proc_create(grn_ctx *ctx, const char *name, int name_size, grn_proc_type type, grn_proc_func *init, grn_proc_func *next, grn_proc_func *fin, unsigned int nvars, grn_expr_var *vars)

   nameに対応する新たなproc(手続き)をctxが使用するdbに定義します。

   :param name: 作成するprocの名前を指定します。
   :param name_size: The number of bytes of name parameter. If negative value is specified, name parameter is assumed that NULL-terminated string.
   :param type: procの種類を指定します。
   :param init: 初期化関数のポインタを指定します。
   :param next: 実処理関数のポインタを指定します。
   :param fin: 終了関数のポインタを指定します。
   :param nvars: procで使用する変数の数を指定します。
   :param vars: procで使用する変数の定義を指定します。( :c:type:`grn_expr_var` 構造体の配列)

.. c:function:: grn_obj *grn_proc_get_info(grn_ctx *ctx, grn_user_data *user_data, grn_expr_var **vars, unsigned int *nvars, grn_obj **caller)

   user_dataをキーとして、現在実行中の :c:type:`grn_proc_func` 関数および定義されている変数( :c:type:`grn_expr_var` )の配列とその数を取得します。

   :param user_data: :c:type:`grn_proc_func` に渡されたuser_dataを指定します。
   :param nvars: 変数の数を取得します。

.. c:function:: grn_rc grn_obj_set_finalizer(grn_ctx *ctx, grn_obj *obj, grn_proc_func *func)

   objectを破棄するときに呼ばれる関数を設定します。

   table, column, proc, exprのみ設定可能です。

   :param obj: 対象objectを指定します。
   :param func: objectを破棄するときに呼ばれる関数を指定します。