<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>8.14.1. grn_ctx — groonga v3.0.5 documentation</title> <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" /> <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../../', VERSION: '3.0.5', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../../_static/jquery.js"></script> <script type="text/javascript" src="../../_static/underscore.js"></script> <script type="text/javascript" src="../../_static/doctools.js"></script> <link rel="shortcut icon" href="../../_static/favicon.ico"/> <link rel="top" title="groonga v3.0.5 documentation" href="../../index.html" /> <link rel="up" title="8.14. API" href="../api.html" /> <link rel="next" title="8.14.2. grn_expr" href="grn_expr.html" /> <link rel="prev" title="8.14. API" href="../api.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/grn_ctx.html"><img src="../../_static/jp.png" alt="日本語">日本語版はこちら</a></li> </ul> </div> </div> <div class="related"> <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_expr.html" title="8.14.2. grn_expr" accesskey="N">next</a> |</li> <li class="right" > <a href="../api.html" title="8.14. API" accesskey="P">previous</a> |</li> <li><a href="../../index.html">groonga v3.0.5 documentation</a> »</li> <li><a href="../../reference.html" >8. リファレンスマニュアル</a> »</li> <li><a href="../api.html" accesskey="U">8.14. API</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="grn-ctx"> <h1>8.14.1. <tt class="docutils literal"><span class="pre">grn_ctx</span></tt><a class="headerlink" href="#grn-ctx" title="Permalink to this headline">¶</a></h1> <div class="section" id="summary"> <h2>8.14.1.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2> <p><a class="reference internal" href="#grn_ctx" title="grn_ctx"><tt class="xref c c-type docutils literal"><span class="pre">grn_ctx</span></tt></a> is the most important object. <a class="reference internal" href="#grn_ctx" title="grn_ctx"><tt class="xref c c-type docutils literal"><span class="pre">grn_ctx</span></tt></a> keeps the current infomation such as:</p> <ul class="simple"> <li>The last occurred error.</li> <li>The current encoding.</li> <li>The default thresholds. (e.g. <a class="reference internal" href="../commands/select.html#match-escalation-threshold"><em>match_escalation_threshold</em></a>)</li> <li>The default command version. (See <a class="reference internal" href="../command/command_version.html"><em>コマンドバージョン</em></a>)</li> </ul> <p><a class="reference internal" href="#grn_ctx" title="grn_ctx"><tt class="xref c c-type docutils literal"><span class="pre">grn_ctx</span></tt></a> provides platform features such as:</p> <ul class="simple"> <li>Memory management.</li> <li>Logging.</li> </ul> <p>Most APIs receive <a class="reference internal" href="#grn_ctx" title="grn_ctx"><tt class="xref c c-type docutils literal"><span class="pre">grn_ctx</span></tt></a> as the first argument.</p> <p>You can't use the same <a class="reference internal" href="#grn_ctx" title="grn_ctx"><tt class="xref c c-type docutils literal"><span class="pre">grn_ctx</span></tt></a> from two or more threads. You need to create a <a class="reference internal" href="#grn_ctx" title="grn_ctx"><tt class="xref c c-type docutils literal"><span class="pre">grn_ctx</span></tt></a> for a thread. You can use two or more <a class="reference internal" href="#grn_ctx" title="grn_ctx"><tt class="xref c c-type docutils literal"><span class="pre">grn_ctx</span></tt></a> in a thread but it is not needed for usual use-case.</p> </div> <div class="section" id="example"> <h2>8.14.1.2. Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2> <p>TODO...</p> </div> <div class="section" id="reference"> <h2>8.14.1.3. Reference<a class="headerlink" href="#reference" title="Permalink to this headline">¶</a></h2> <dl class="type"> <dt id="grn_ctx"> <tt class="descname">grn_ctx</tt><a class="headerlink" href="#grn_ctx" title="Permalink to this definition">¶</a></dt> <dd><p>TODO...</p> </dd></dl> <dl class="function"> <dt id="grn_ctx_init"> grn_rc <tt class="descname">grn_ctx_init</tt><big>(</big><a class="reference internal" href="#grn_ctx" title="grn_ctx">grn_ctx</a><em> *ctx</em>, int<em> flags</em><big>)</big><a class="headerlink" href="#grn_ctx_init" title="Permalink to this definition">¶</a></dt> <dd><p>ctxを初期化します。</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> <li><strong>ctx</strong> -- 初期化するctx構造体へのポインタを指定します。</li> <li><strong>flags</strong> -- 初期化する <tt class="docutils literal"><span class="pre">ctx</span></tt> のオプションを指定します。</li> </ul> </td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><tt class="docutils literal"><span class="pre">GRN_SUCCESS</span></tt> on success, not <tt class="docutils literal"><span class="pre">GRN_SUCCESS</span></tt> on error.</p> </td> </tr> </tbody> </table> </dd></dl> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="../../index.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">8.14.1. <tt class="docutils literal"><span class="pre">grn_ctx</span></tt></a><ul> <li><a class="reference internal" href="#summary">8.14.1.1. Summary</a></li> <li><a class="reference internal" href="#example">8.14.1.2. Example</a></li> <li><a class="reference internal" href="#reference">8.14.1.3. Reference</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="../api.html" title="previous chapter">8.14. API</a></p> <h4>Next topic</h4> <p class="topless"><a href="grn_expr.html" title="next chapter">8.14.2. grn_expr</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../../_sources/reference/api/grn_ctx.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <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_expr.html" title="8.14.2. grn_expr" >next</a> |</li> <li class="right" > <a href="../api.html" title="8.14. API" >previous</a> |</li> <li><a href="../../index.html">groonga v3.0.5 documentation</a> »</li> <li><a href="../../reference.html" >8. リファレンスマニュアル</a> »</li> <li><a href="../api.html" >8.14. API</a> »</li> </ul> </div> <div class="footer"> © Copyright 2009-2013, Brazil, Inc. </div> </body> </html>