[Groonga-commit] groonga/groonga at 65f10d3 [master] doc: document grn_ctx_is_opened()

Zurück zum Archiv-Index

Kouhei Sutou null+****@clear*****
Sun Sep 27 23:15:59 JST 2015


Kouhei Sutou	2015-09-27 23:15:59 +0900 (Sun, 27 Sep 2015)

  New Revision: 65f10d3fb8ed098881710a0bcdabce5b0bbcc7e5
  https://github.com/groonga/groonga/commit/65f10d3fb8ed098881710a0bcdabce5b0bbcc7e5

  Message:
    doc: document grn_ctx_is_opened()

  Modified files:
    doc/source/reference/api/grn_ctx.rst

  Modified: doc/source/reference/api/grn_ctx.rst (+9 -0)
===================================================================
--- doc/source/reference/api/grn_ctx.rst    2015-09-27 22:39:15 +0900 (ac0941f)
+++ doc/source/reference/api/grn_ctx.rst    2015-09-27 23:15:59 +0900 (d9079b8)
@@ -184,3 +184,12 @@ Reference
    :param ctx: The context object.
    :param type: The new output type.
    :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.
+
+.. c:function:: grn_bool_rc grn_ctx_is_opened(grn_ctx *ctx, grn_id id)
+
+   Checks whether object with the ID is opened or not.
+
+   :param ctx: The context object.
+   :param id: The object ID to be checked.
+   :return: ``GRN_TRUE`` if object with the ID is opened,
+            ``GRN_FALSE`` otherwise.
-------------- next part --------------
HTML����������������������������...
Download 



More information about the Groonga-commit mailing list
Zurück zum Archiv-Index