[Groonga-commit] groonga/groonga at 6ee54e9 [master] doc: add api reference for "grn_obj_is_index_column"

アーカイブの一覧に戻る

Yasuhiro Horimoto null+****@clear*****
Thu Jun 21 14:56:12 JST 2018


Yasuhiro Horimoto	2018-06-21 14:56:12 +0900 (Thu, 21 Jun 2018)

  New Revision: 6ee54e9476834c60afe2a2aa0711f54c09ab3933
  https://github.com/groonga/groonga/commit/6ee54e9476834c60afe2a2aa0711f54c09ab3933

  Merged e75a04f: Merge pull request #855 from komainu8/add_api_document

  Message:
    doc: add api reference for "grn_obj_is_index_column"

  Modified files:
    doc/locale/ja/LC_MESSAGES/reference.po
    doc/source/reference/api/grn_obj.rst

  Modified: doc/locale/ja/LC_MESSAGES/reference.po (+14 -0)
===================================================================
--- doc/locale/ja/LC_MESSAGES/reference.po    2018-06-18 17:54:10 +0900 (b46d8151e)
+++ doc/locale/ja/LC_MESSAGES/reference.po    2018-06-21 14:56:12 +0900 (b1bba8d1c)
@@ -1493,6 +1493,20 @@ msgstr ""
 msgid "``GRN_TRUE`` for built-in groonga object, ``GRN_FALSE`` otherwise."
 msgstr ""
 
+msgid "Check whether index column."
+msgstr "インデックスカラムかどうかを判定します。"
+
+msgid "The target object."
+msgstr "対象のオブジェクト"
+
+msgid ""
+"``GRN_TRUE`` for if the target object is index column, ``GRN_FALSE`` "
+"otherwise. Even if the target object isn't column, return ``GRN_FALSE``."
+msgstr ""
+"対象のオブジェクトがインデックスカラムの場合には、 ``GRN_TRUE`` です。それ以"
+"外の場合は、 ``GRN_FALSE`` です。対象のオブジェクトがカラム以外の場合も "
+"``GRN_FALSE`` を返します。"
+
 msgid ""
 "objのIDに対応するレコードのvalueを取得します。valueを戻り値として返します。"
 msgstr ""

  Modified: doc/source/reference/api/grn_obj.rst (+8 -0)
===================================================================
--- doc/source/reference/api/grn_obj.rst    2018-06-18 17:54:10 +0900 (63818e937)
+++ doc/source/reference/api/grn_obj.rst    2018-06-21 14:56:12 +0900 (959f8752c)
@@ -39,6 +39,14 @@ Reference
    :param obj: target object
    :return: ``GRN_TRUE`` for built-in groonga object, ``GRN_FALSE`` otherwise.
 
+.. c:function:: grn_bool grn_obj_is_index_column(grn_ctx *ctx, grn_obj *obj)
+
+   Check whether index column.
+
+   :param ctx: The context object.
+   :param obj: The target object.
+   :return: ``GRN_TRUE`` for if the target object is index column, ``GRN_FALSE`` otherwise. Even if the target object isn't column, return ``GRN_FALSE``.
+
 .. c:function:: grn_obj *grn_obj_get_value(grn_ctx *ctx, grn_obj *obj, grn_id id, grn_obj *value)
 
    objのIDに対応するレコードのvalueを取得します。valueを戻り値として返します。
-------------- next part --------------
HTML����������������������������...
URL: https://lists.osdn.me/mailman/archives/groonga-commit/attachments/20180621/ff922189/attachment-0001.htm 



More information about the Groonga-commit mailing list
アーカイブの一覧に戻る