File: plugin.html

package info (click to toggle)
groonga 11.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 121,576 kB
  • sloc: ansic: 801,209; javascript: 62,121; ruby: 46,206; cpp: 33,790; xml: 24,951; yacc: 13,333; sh: 7,776; python: 3,266; makefile: 2,315; perl: 133
file content (353 lines) | stat: -rw-r--r-- 23,535 bytes parent folder | download
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353


<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>7.25.3. Plugin &#8212; Groonga v10.1.1-31-g1e46ba6 documentation</title>
    <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    
    <link rel="shortcut icon" href="../../_static/favicon.ico"/>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="7.25.4. grn_cache" href="grn_cache.html" />
    <link rel="prev" title="7.25.2. Global configurations" href="global_configurations.html" /> 
  </head><body>
<div class="header">
  <h1 class="title">
    <a id="top-link" href="../../index.html">
      <span class="project">groonga</span>
      <span class="separator">-</span>
      <span class="description">An open-source fulltext search engine and column store.</span>
    </a>
  </h1>

  <div class="other-language-links">
    <ul>
      <li><a href="../../../../ja/html/reference/api/plugin.html">日本語</a></li>
    </ul>
  </div>
</div>
  

    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="grn_cache.html" title="7.25.4. grn_cache"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="global_configurations.html" title="7.25.2. Global configurations"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="../api.html" accesskey="U"><span class="section-number">7.25. </span>API</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.25.3. </span>Plugin</a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="plugin">
<h1><span class="section-number">7.25.3. </span>Plugin<a class="headerlink" href="#plugin" title="Permalink to this headline">¶</a></h1>
<div class="section" id="summary">
<h2><span class="section-number">7.25.3.1. </span>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p>Groonga supports plugin. You can create a new plugin with the
following API.</p>
<p>TOOD: Describe about how to create the minimum plugin here or create a
tutorial about it.</p>
</div>
<div class="section" id="reference">
<h2><span class="section-number">7.25.3.2. </span>Reference<a class="headerlink" href="#reference" title="Permalink to this headline">¶</a></h2>
<dl class="c function">
<dt id="c.GRN_PLUGIN_INIT">
grn_rc <code class="sig-name descname">GRN_PLUGIN_INIT</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a> *<em>ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.GRN_PLUGIN_INIT" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="c function">
<dt id="c.GRN_PLUGIN_REGISTER">
grn_rc <code class="sig-name descname">GRN_PLUGIN_REGISTER</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a> *<em>ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.GRN_PLUGIN_REGISTER" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="c function">
<dt id="c.GRN_PLUGIN_FIN">
grn_rc <code class="sig-name descname">GRN_PLUGIN_FIN</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a> *<em>ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.GRN_PLUGIN_FIN" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="c macro">
<dt id="c.GRN_PLUGIN_MALLOC">
<code class="sig-name descname">GRN_PLUGIN_MALLOC</code><span class="sig-paren">(</span><em>ctx</em>, <em>size</em><span class="sig-paren">)</span><a class="headerlink" href="#c.GRN_PLUGIN_MALLOC" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>GRN_PLUGIN_MALLOC() allocates <cite>size</cite> bytes and returns a pointer to the
allocated memory space. Note that the memory space is associated with <cite>ctx</cite>.</p>
</dd></dl>

<dl class="c macro">
<dt id="c.GRN_PLUGIN_REALLOC">
<code class="sig-name descname">GRN_PLUGIN_REALLOC</code><span class="sig-paren">(</span><em>ctx</em>, <em>ptr</em>, <em>size</em><span class="sig-paren">)</span><a class="headerlink" href="#c.GRN_PLUGIN_REALLOC" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>GRN_PLUGIN_REALLOC() resizes the memory space pointed to by <cite>ptr</cite> or
allocates a new memory space of <cite>size</cite> bytes. GRN_PLUGIN_REALLOC() returns
a pointer to the memory space. The contents is unchanged or copied from the
old memory space to the new memory space.</p>
</dd></dl>

<dl class="c macro">
<dt id="c.GRN_PLUGIN_FREE">
<code class="sig-name descname">GRN_PLUGIN_FREE</code><span class="sig-paren">(</span><em>ctx</em>, <em>ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#c.GRN_PLUGIN_FREE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>GRN_PLUGIN_FREE() frees a memory space allocated by GRN_PLUGIN_MALLOC() or
GRN_PLUGIN_REALLOC(). This means that <cite>ptr</cite> must be a pointer returned by
GRN_PLUGIN_MALLOC() or GRN_PLUGIN_REALLOC().</p>
</dd></dl>

<dl class="c macro">
<dt id="c.GRN_PLUGIN_LOG">
<code class="sig-name descname">GRN_PLUGIN_LOG</code><span class="sig-paren">(</span><em>ctx</em>, <em>level</em>, ...<span class="sig-paren">)</span><a class="headerlink" href="#c.GRN_PLUGIN_LOG" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>GRN_PLUGIN_LOG() reports a log of <cite>level</cite>. Its error message is generated
from the varying number of arguments, in which the first one is the format
string and the rest are its arguments. See grn_log_level in “groonga.h” for
more details of <cite>level</cite>.</p>
</dd></dl>

<dl class="c macro">
<dt id="c.GRN_PLUGIN_ERROR">
<code class="sig-name descname">GRN_PLUGIN_ERROR</code><span class="sig-paren">(</span><em>ctx</em>, <em>error_code</em>, ...<span class="sig-paren">)</span><a class="headerlink" href="#c.GRN_PLUGIN_ERROR" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>GRN_PLUGIN_ERROR() reports an error of <cite>error_code</cite>. Its error message is
generated from the varying number of arguments, in which the first one is the
format string and the rest are its arguments. See grn_rc in “groonga.h” for
more details of <cite>error_code</cite>.</p>
</dd></dl>

<dl class="c type">
<dt id="c.grn_plugin_mutex">
<em class="property">type </em><code class="sig-name descname">grn_plugin_mutex</code><a class="headerlink" href="#c.grn_plugin_mutex" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>grn_plugin_mutex is available to make a critical section. See the
following functions.</p>
</dd></dl>

<dl class="c function">
<dt id="c.grn_plugin_mutex_open">
<a class="reference internal" href="#c.grn_plugin_mutex" title="grn_plugin_mutex">grn_plugin_mutex</a> *<code class="sig-name descname">grn_plugin_mutex_open</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a> *<em>ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_mutex_open" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>grn_plugin_mutex_open() returns a pointer to a new object of
grn_plugin_mutex. Memory for the new object is obtained with
GRN_PLUGIN_MALLOC(). grn_plugin_mutex_open() returns NULL if sufficient
memory is not available.</p>
</dd></dl>

<dl class="c function">
<dt id="c.grn_plugin_mutex_close">
void <code class="sig-name descname">grn_plugin_mutex_close</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a> *<em>ctx</em>, <a class="reference internal" href="#c.grn_plugin_mutex" title="grn_plugin_mutex">grn_plugin_mutex</a> *<em>mutex</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_mutex_close" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>grn_plugin_mutex_close() finalizes an object of grn_plugin_mutex and then
frees memory allocated for that object.</p>
</dd></dl>

<dl class="c function">
<dt id="c.grn_plugin_mutex_lock">
void <code class="sig-name descname">grn_plugin_mutex_lock</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a> *<em>ctx</em>, <a class="reference internal" href="#c.grn_plugin_mutex" title="grn_plugin_mutex">grn_plugin_mutex</a> *<em>mutex</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_mutex_lock" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>grn_plugin_mutex_lock() locks a mutex object. If the object is already
locked, the calling thread waits until the object will be unlocked.</p>
</dd></dl>

<dl class="c function">
<dt id="c.grn_plugin_mutex_unlock">
void <code class="sig-name descname">grn_plugin_mutex_unlock</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a> *<em>ctx</em>, <a class="reference internal" href="#c.grn_plugin_mutex" title="grn_plugin_mutex">grn_plugin_mutex</a> *<em>mutex</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_mutex_unlock" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>grn_plugin_mutex_unlock() unlocks a mutex object. grn_plugin_mutex_unlock()
should not be called for an unlocked object.</p>
</dd></dl>

<dl class="c function">
<dt id="c.grn_plugin_proc_alloc">
<a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> *<code class="sig-name descname">grn_plugin_proc_alloc</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a> *<em>ctx</em>, <a class="reference internal" href="grn_user_data.html#c.grn_user_data" title="grn_user_data">grn_user_data</a> *<em>user_data</em>, grn_id <em>domain</em>, grn_obj_flags <em>flags</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_proc_alloc" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>grn_plugin_proc_alloc() allocates a <cite>grn_obj</cite> object.
You can use it in function that is registered as GRN_PROC_FUNCTION.</p>
</dd></dl>

<dl class="c function">
<dt id="c.grn_plugin_proc_get_var">
<a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> <code class="sig-name descname">grn_plugin_proc_get_var</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a> *<em>ctx</em>, <a class="reference internal" href="grn_user_data.html#c.grn_user_data" title="grn_user_data">grn_user_data</a> *<em>user_data</em>, <em class="property">const</em> char *<em>name</em>, int <em>name_size</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_proc_get_var" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>It gets a variable value from <cite>grn_user_data</cite> by specifying the variable name.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> – The variable name.</p></li>
<li><p><strong>name_size</strong> – The number of bytes of name. If <cite>name_size</cite> is negative, <cite>name</cite> must be NUL-terminated. <cite>name_size</cite> is computed by <cite>strlen(name)</cite> for the case.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A variable value on success, NULL otherwise.</p>
</dd>
</dl>
</dd></dl>

<dl class="c function">
<dt id="c.grn_plugin_proc_get_var_by_offset">
<a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> *<code class="sig-name descname">grn_plugin_proc_get_var_by_offset</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a> *<em>ctx</em>, <a class="reference internal" href="grn_user_data.html#c.grn_user_data" title="grn_user_data">grn_user_data</a> *<em>user_data</em>, unsigned int <em>offset</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_proc_get_var_by_offset" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>It gets a variable value from <cite>grn_user_data</cite> by specifying the offset position of the variable.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>offset</strong> – The offset position of the variable.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A variable value on success, NULL otherwise.</p>
</dd>
</dl>
</dd></dl>

<dl class="c function">
<dt id="c.grn_plugin_win32_base_dir">
<em class="property">const</em> char *<code class="sig-name descname">grn_plugin_win32_base_dir</code><span class="sig-paren">(</span>void<span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_win32_base_dir" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 5.0.9.: </span>Use <a class="reference internal" href="#c.grn_plugin_windows_base_dir" title="grn_plugin_windows_base_dir"><code class="xref c c-func docutils literal notranslate"><span class="pre">grn_plugin_windows_base_dir()</span></code></a>
instead.</p>
</div>
<p>It returns the Groonga install directory. The install directory is
computed from the directory that has <code class="docutils literal notranslate"><span class="pre">groonga.dll</span></code>. You can use
the directory to generate install directory aware path. It only
works on Windows. It returns <code class="docutils literal notranslate"><span class="pre">NULL</span></code> on other platforms.</p>
</dd></dl>

<dl class="c function">
<dt id="c.grn_plugin_windows_base_dir">
<em class="property">const</em> char *<code class="sig-name descname">grn_plugin_windows_base_dir</code><span class="sig-paren">(</span>void<span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_windows_base_dir" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="versionadded">
<p><span class="versionmodified added">New in version 5.0.9.</span></p>
</div>
<p>It returns the Groonga install directory. The install directory is
computed from the directory that has <code class="docutils literal notranslate"><span class="pre">groonga.dll</span></code>. You can use
the directory to generate install directory aware path. It only
works on Windows. It returns <code class="docutils literal notranslate"><span class="pre">NULL</span></code> on other platforms.</p>
</dd></dl>

<dl class="c function">
<dt id="c.grn_plugin_charlen">
int <code class="sig-name descname">grn_plugin_charlen</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a> *<em>ctx</em>, <em class="property">const</em> char *<em>str_ptr</em>, unsigned int <em>str_length</em>, <a class="reference internal" href="grn_encoding.html#c.grn_encoding" title="grn_encoding">grn_encoding</a> <em>encoding</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_charlen" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>grn_plugin_charlen() returns the length (#bytes) of the first character
in the string specified by <cite>str_ptr</cite> and <cite>str_length</cite>. If the starting bytes
are invalid as a character, grn_plugin_charlen() returns 0. See
grn_encoding in “groonga.h” for more details of <cite>encoding</cite>.</p>
</dd></dl>

<dl class="c function">
<dt id="c.grn_plugin_isspace">
int <code class="sig-name descname">grn_plugin_isspace</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a> *<em>ctx</em>, <em class="property">const</em> char *<em>str_ptr</em>, unsigned int <em>str_length</em>, <a class="reference internal" href="grn_encoding.html#c.grn_encoding" title="grn_encoding">grn_encoding</a> <em>encoding</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_isspace" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>grn_plugin_isspace() returns the length (#bytes) of the first character
in the string specified by <cite>str_ptr</cite> and <cite>str_length</cite> if it is a space
character. Otherwise, grn_plugin_isspace() returns 0.</p>
</dd></dl>

<dl class="c function">
<dt id="c.grn_plugin_expr_var_init">
grn_rc <code class="sig-name descname">grn_plugin_expr_var_init</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a> *<em>ctx</em>, grn_expr_var *<em>var</em>, <em class="property">const</em> char *<em>name</em>, int <em>name_size</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_expr_var_init" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>It initializes a <cite>grn_expr_var</cite>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>var</strong> – The pointer of <cite>grn_expr_var</cite> object to be initialized.</p></li>
<li><p><strong>name</strong> – The name of <cite>grn_expr_var</cite> object to be initialized.</p></li>
<li><p><strong>name_size</strong> – The number of bytes of name. If <cite>name_size</cite> is negative, <cite>name</cite> must be NUL-terminated. <cite>name_size</cite> is computed by <cite>strlen(name)</cite> for the case.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">GRN_SUCCESS</span></code>. It doesn’t fail.</p>
</dd>
</dl>
</dd></dl>

<dl class="c function">
<dt id="c.grn_plugin_command_create">
<a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> *<code class="sig-name descname">grn_plugin_command_create</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a> *<em>ctx</em>, <em class="property">const</em> char *<em>name</em>, int <em>name_size</em>, <a class="reference internal" href="grn_proc.html#c.grn_proc_func" title="grn_proc_func">grn_proc_func</a> <em>func</em>, unsigned int <em>n_vars</em>, grn_expr_var *<em>vars</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_command_create" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>It creates a command.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> – The <cite>proc</cite> name of the command to be created.</p></li>
<li><p><strong>name_size</strong> – The number of bytes of name. If <cite>name_size</cite> is negative, <cite>name</cite> must be NUL-terminated. <cite>name_size</cite> is computed by <cite>strlen(name)</cite> for the case.</p></li>
<li><p><strong>func</strong> – The function name to be called by the created command.</p></li>
<li><p><strong>n_vars</strong> – The number of the variables of the command to create.</p></li>
<li><p><strong>vars</strong> – The pointer of initialized <cite>grn_expr_var</cite> object.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The created command object if it creates a command successfully,
<cite>NULL</cite> otherwise. See <cite>ctx</cite> for error details.</p>
</dd>
</dl>
</dd></dl>

</div>
</div>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../../index.html">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">7.25.3. Plugin</a><ul>
<li><a class="reference internal" href="#summary">7.25.3.1. Summary</a></li>
<li><a class="reference internal" href="#reference">7.25.3.2. Reference</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="global_configurations.html"
                        title="previous chapter"><span class="section-number">7.25.2. </span>Global configurations</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="grn_cache.html"
                        title="next chapter"><span class="section-number">7.25.4. </span><code class="docutils literal notranslate"><span class="pre">grn_cache</span></code></a></p>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="grn_cache.html" title="7.25.4. grn_cache"
             >next</a> |</li>
        <li class="right" >
          <a href="global_configurations.html" title="7.25.2. Global configurations"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="../api.html" ><span class="section-number">7.25. </span>API</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.25.3. </span>Plugin</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2009-2021, Brazil, Inc.
    </div>
  </body>
</html>