naoa
null+****@clear*****
Fri Jun 20 17:57:17 JST 2014
naoa 2014-06-20 17:57:17 +0900 (Fri, 20 Jun 2014) New Revision: a6a531179ef45f51a2c06fd4182457d94868c0e8 https://github.com/groonga/groonga/commit/a6a531179ef45f51a2c06fd4182457d94868c0e8 Merged cc0ae25: Merge pull request #178 from naoa/doc-plugin-api-reference Message: doc:add grn_plugin_expr_var_init and grn_plugin_command_create TODO: Translate it in doc/locale/ja/LC_MESSAGES/reference.po Translate it in doc/locale/en/LC_MESSAGES/reference.po Modified files: doc/source/reference/api/plugin.rst Modified: doc/source/reference/api/plugin.rst (+19 -0) =================================================================== --- doc/source/reference/api/plugin.rst 2014-06-20 17:51:48 +0900 (ac46c6f) +++ doc/source/reference/api/plugin.rst 2014-06-20 17:57:17 +0900 (d51609f) @@ -32,3 +32,22 @@ Reference :param offset: The offset position of the variable. :return: A variable value on success, NULL otherwise. +.. c:function:: grn_rc grn_plugin_expr_var_init(grn_ctx *ctx, grn_expr_var *var, const char *name, int name_size); + + It initializes a `grn_expr_var`. + + :param var: The pointer of `grn_expr_var` object to initialize. + :param name: The name of `grn_expr_var` object to initialize. + :param name_size: The number of bytes of name. If `name_size` is negative, `name` must be NUL-terminated. `name_size` is computed by `strlen(name)` for the case. + :return: ``GRN_SUCCESS``. It doesn't fail. + +.. c:function:: grn_obj * grn_plugin_command_create(grn_ctx *ctx, const char *name, int name_size, grn_proc_func func, unsigned int n_vars, grn_expr_var *vars); + + It creates a command. + + :param name: The `proc` name of the command to create. + :param name_size: The number of bytes of name. If `name_size` is negative, `name` must be NUL-terminated. `name_size` is computed by `strlen(name)` for the case. + :param func: The function name to be called by the created command. + :param n_vars: The number of the variables of the command to create. + :param vars: The pointer of initialized `grn_expr_var` object. + :return: ``GRN_SUCCESS``. It doesn't fail. -------------- next part -------------- HTML����������������������������...Download