7.25.15. grn_index_cursor — Groonga v14.0.6 documentation

Skip to main content
`Ctrl`+`K`

# 7.25.15. `grn_index_cursor`

## 7.25.15.1. Summary

TODO…

## 7.25.15.2. Example

TODO…

## 7.25.15.3. Reference

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)

  `grn_table_cursor` から取得できるそれぞれのレコードについて、 `GRN_OBJ_COLUMN_INDEX` 型のカラムの値を順番に取り出すためのカーソルを生成して返します。

  rid_min, rid_maxを指定して取得するレコードidの値を制限することができます。

  戻り値であるgrn_index_cursorは `grn_obj_close()` を使って解放します。

  Parameters:

    - tc – 対象cursorを指定します。

    - index – 対象インデックスカラムを指定します。

    - rid_min – 出力するレコードidの下限を指定します。

    - rid_max – 出力するレコードidの上限を指定します。

grn_posting *grn_index_cursor_next(grn_ctx *ctx, grn_obj *ic, grn_id *tid)

  cursorの範囲内のインデックスの値を順番に取り出します。

  tidにNULL以外を指定した場合は、index_cursorを作成するときに指定したtable_cursorの現在の対象レコードのidを返します。

  戻り値である `grn_posting` 構造体は解放する必要はありません。

  Parameters:

    - ic – 対象cursorを指定します。

    - tid – テーブルレコードIDを指定します。