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
|
.. -*- rst -*-
.. highlightlang:: none
``grn_index_cursor``
====================
Summary
-------
TODO...
Example
-------
TODO...
Reference
---------
.. c:function:: grn_obj *grn_index_cursor_open(grn_ctx *ctx, grn_table_cursor *tc, grn_obj *index, grn_id rid_min, grn_id rid_max, int flags)
:c:type:`grn_table_cursor` から取得できるそれぞれのレコードについて、 ``GRN_OBJ_COLUMN_INDEX`` 型のカラムの値を順番に取り出すためのカーソルを生成して返します。
rid_min, rid_maxを指定して取得するレコードidの値を制限することができます。
戻り値であるgrn_index_cursorは :c:func:`grn_obj_close()` を使って解放します。
:param tc: 対象cursorを指定します。
:param index: 対象インデックスカラムを指定します。
:param rid_min: 出力するレコードidの下限を指定します。
:param rid_max: 出力するレコードidの上限を指定します。
.. c:function:: grn_posting *grn_index_cursor_next(grn_ctx *ctx, grn_obj *ic, grn_id *tid)
cursorの範囲内のインデックスの値を順番に取り出します。
tidにNULL以外を指定した場合は、index_cursorを作成するときに指定したtable_cursorの現在の対象レコードのidを返します。
戻り値である :c:type:`grn_posting` 構造体は解放する必要はありません。
:param ic: 対象cursorを指定します。
:param tid: テーブルレコードIDを指定します。
|