Sophie

Sophie

distrib > Fedora > 18 > x86_64 > media > updates > by-pkgid > e450e7f3d6075c4a54de19e68d38177f > files > 245

groonga-doc-3.0.5-1.fc18.x86_64.rpm


<!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.3.3. Return code &mdash; 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.3. Command" href="../command.html" />
    <link rel="next" title="8.3.4. cache_limit" href="../commands/cache_limit.html" />
    <link rel="prev" title="8.3.2. Output format" href="output_format.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/command/return_code.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="../commands/cache_limit.html" title="8.3.4. cache_limit"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="output_format.html" title="8.3.2. Output format"
             accesskey="P">previous</a> |</li>
        <li><a href="../../index.html">groonga v3.0.5 documentation</a> &raquo;</li>
          <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
          <li><a href="../command.html" accesskey="U">8.3. Command</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="return-code">
<h1>8.3.3. Return code<a class="headerlink" href="#return-code" title="Permalink to this headline">¶</a></h1>
<div class="section" id="summary">
<h2>8.3.3.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p>Return code is used to show whether a processing is succeeded or
not. If the processing is not succeeded, return code shows error type.</p>
<p>Return code is used in C API and query API. You can check return code
via <tt class="docutils literal"><span class="pre">grn_ctx_t::rc</span></tt> in C API. You can check return code by looking
the header element in query API. See <a class="reference internal" href="output_format.html"><em>Output format</em></a> about the
header element in query API.</p>
</div>
<div class="section" id="list">
<h2>8.3.3.2. List<a class="headerlink" href="#list" title="Permalink to this headline">¶</a></h2>
<p>Here is a list of return codes. <tt class="docutils literal"><span class="pre">GRN_SUCCESS</span></tt> (= 0) means that the
processing is succeeded. Return codes that have negative value show
error type. <tt class="docutils literal"><span class="pre">GRN_END_OF_DATA</span></tt> is a special return code. It is used
only C API. It is not showen in query API.</p>
<ul class="simple">
<li>0: <tt class="docutils literal"><span class="pre">GRN_SUCCESS</span></tt></li>
<li>1: <tt class="docutils literal"><span class="pre">GRN_END_OF_DATA</span></tt></li>
<li>-1: <tt class="docutils literal"><span class="pre">GRN_UNKNOWN_ERROR</span></tt></li>
<li>-2: <tt class="docutils literal"><span class="pre">GRN_OPERATION_NOT_PERMITTED</span></tt></li>
<li>-3: <tt class="docutils literal"><span class="pre">GRN_NO_SUCH_FILE_OR_DIRECTORY</span></tt></li>
<li>-4: <tt class="docutils literal"><span class="pre">GRN_NO_SUCH_PROCESS</span></tt></li>
<li>-5: <tt class="docutils literal"><span class="pre">GRN_INTERRUPTED_FUNCTION_CALL</span></tt></li>
<li>-6: <tt class="docutils literal"><span class="pre">GRN_INPUT_OUTPUT_ERROR</span></tt></li>
<li>-7: <tt class="docutils literal"><span class="pre">GRN_NO_SUCH_DEVICE_OR_ADDRESS</span></tt></li>
<li>-8: <tt class="docutils literal"><span class="pre">GRN_ARG_LIST_TOO_LONG</span></tt></li>
<li>-9: <tt class="docutils literal"><span class="pre">GRN_EXEC_FORMAT_ERROR</span></tt></li>
<li>-10: <tt class="docutils literal"><span class="pre">GRN_BAD_FILE_DESCRIPTOR</span></tt></li>
<li>-11: <tt class="docutils literal"><span class="pre">GRN_NO_CHILD_PROCESSES</span></tt></li>
<li>-12: <tt class="docutils literal"><span class="pre">GRN_RESOURCE_TEMPORARILY_UNAVAILABLE</span></tt></li>
<li>-13: <tt class="docutils literal"><span class="pre">GRN_NOT_ENOUGH_SPACE</span></tt></li>
<li>-14: <tt class="docutils literal"><span class="pre">GRN_PERMISSION_DENIED</span></tt></li>
<li>-15: <tt class="docutils literal"><span class="pre">GRN_BAD_ADDRESS</span></tt></li>
<li>-16: <tt class="docutils literal"><span class="pre">GRN_RESOURCE_BUSY</span></tt></li>
<li>-17: <tt class="docutils literal"><span class="pre">GRN_FILE_EXISTS</span></tt></li>
<li>-18: <tt class="docutils literal"><span class="pre">GRN_IMPROPER_LINK</span></tt></li>
<li>-19: <tt class="docutils literal"><span class="pre">GRN_NO_SUCH_DEVICE</span></tt></li>
<li>-20: <tt class="docutils literal"><span class="pre">GRN_NOT_A_DIRECTORY</span></tt></li>
<li>-21: <tt class="docutils literal"><span class="pre">GRN_IS_A_DIRECTORY</span></tt></li>
<li>-22: <tt class="docutils literal"><span class="pre">GRN_INVALID_ARGUMENT</span></tt></li>
<li>-23: <tt class="docutils literal"><span class="pre">GRN_TOO_MANY_OPEN_FILES_IN_SYSTEM</span></tt></li>
<li>-24: <tt class="docutils literal"><span class="pre">GRN_TOO_MANY_OPEN_FILES</span></tt></li>
<li>-25: <tt class="docutils literal"><span class="pre">GRN_INAPPROPRIATE_I_O_CONTROL_OPERATION</span></tt></li>
<li>-26: <tt class="docutils literal"><span class="pre">GRN_FILE_TOO_LARGE</span></tt></li>
<li>-27: <tt class="docutils literal"><span class="pre">GRN_NO_SPACE_LEFT_ON_DEVICE</span></tt></li>
<li>-28: <tt class="docutils literal"><span class="pre">GRN_INVALID_SEEK</span></tt></li>
<li>-29: <tt class="docutils literal"><span class="pre">GRN_READ_ONLY_FILE_SYSTEM</span></tt></li>
<li>-30: <tt class="docutils literal"><span class="pre">GRN_TOO_MANY_LINKS</span></tt></li>
<li>-31: <tt class="docutils literal"><span class="pre">GRN_BROKEN_PIPE</span></tt></li>
<li>-32: <tt class="docutils literal"><span class="pre">GRN_DOMAIN_ERROR</span></tt></li>
<li>-33: <tt class="docutils literal"><span class="pre">GRN_RESULT_TOO_LARGE</span></tt></li>
<li>-34: <tt class="docutils literal"><span class="pre">GRN_RESOURCE_DEADLOCK_AVOIDED</span></tt></li>
<li>-35: <tt class="docutils literal"><span class="pre">GRN_NO_MEMORY_AVAILABLE</span></tt></li>
<li>-36: <tt class="docutils literal"><span class="pre">GRN_FILENAME_TOO_LONG</span></tt></li>
<li>-37: <tt class="docutils literal"><span class="pre">GRN_NO_LOCKS_AVAILABLE</span></tt></li>
<li>-38: <tt class="docutils literal"><span class="pre">GRN_FUNCTION_NOT_IMPLEMENTED</span></tt></li>
<li>-39: <tt class="docutils literal"><span class="pre">GRN_DIRECTORY_NOT_EMPTY</span></tt></li>
<li>-40: <tt class="docutils literal"><span class="pre">GRN_ILLEGAL_BYTE_SEQUENCE</span></tt></li>
<li>-41: <tt class="docutils literal"><span class="pre">GRN_SOCKET_NOT_INITIALIZED</span></tt></li>
<li>-42: <tt class="docutils literal"><span class="pre">GRN_OPERATION_WOULD_BLOCK</span></tt></li>
<li>-43: <tt class="docutils literal"><span class="pre">GRN_ADDRESS_IS_NOT_AVAILABLE</span></tt></li>
<li>-44: <tt class="docutils literal"><span class="pre">GRN_NETWORK_IS_DOWN</span></tt></li>
<li>-45: <tt class="docutils literal"><span class="pre">GRN_NO_BUFFER</span></tt></li>
<li>-46: <tt class="docutils literal"><span class="pre">GRN_SOCKET_IS_ALREADY_CONNECTED</span></tt></li>
<li>-47: <tt class="docutils literal"><span class="pre">GRN_SOCKET_IS_NOT_CONNECTED</span></tt></li>
<li>-48: <tt class="docutils literal"><span class="pre">GRN_SOCKET_IS_ALREADY_SHUTDOWNED</span></tt></li>
<li>-49: <tt class="docutils literal"><span class="pre">GRN_OPERATION_TIMEOUT</span></tt></li>
<li>-50: <tt class="docutils literal"><span class="pre">GRN_CONNECTION_REFUSED</span></tt></li>
<li>-51: <tt class="docutils literal"><span class="pre">GRN_RANGE_ERROR</span></tt></li>
<li>-52: <tt class="docutils literal"><span class="pre">GRN_TOKENIZER_ERROR</span></tt></li>
<li>-53: <tt class="docutils literal"><span class="pre">GRN_FILE_CORRUPT</span></tt></li>
<li>-54: <tt class="docutils literal"><span class="pre">GRN_INVALID_FORMAT</span></tt></li>
<li>-55: <tt class="docutils literal"><span class="pre">GRN_OBJECT_CORRUPT</span></tt></li>
<li>-56: <tt class="docutils literal"><span class="pre">GRN_TOO_MANY_SYMBOLIC_LINKS</span></tt></li>
<li>-57: <tt class="docutils literal"><span class="pre">GRN_NOT_SOCKET</span></tt></li>
<li>-58: <tt class="docutils literal"><span class="pre">GRN_OPERATION_NOT_SUPPORTED</span></tt></li>
<li>-59: <tt class="docutils literal"><span class="pre">GRN_ADDRESS_IS_IN_USE</span></tt></li>
<li>-60: <tt class="docutils literal"><span class="pre">GRN_ZLIB_ERROR</span></tt></li>
<li>-61: <tt class="docutils literal"><span class="pre">GRN_LZO_ERROR</span></tt></li>
<li>-62: <tt class="docutils literal"><span class="pre">GRN_STACK_OVER_FLOW</span></tt></li>
<li>-63: <tt class="docutils literal"><span class="pre">GRN_SYNTAX_ERROR</span></tt></li>
<li>-64: <tt class="docutils literal"><span class="pre">GRN_RETRY_MAX</span></tt></li>
<li>-65: <tt class="docutils literal"><span class="pre">GRN_INCOMPATIBLE_FILE_FORMAT</span></tt></li>
<li>-66: <tt class="docutils literal"><span class="pre">GRN_UPDATE_NOT_ALLOWED</span></tt></li>
<li>-67: <tt class="docutils literal"><span class="pre">GRN_TOO_SMALL_OFFSET</span></tt></li>
<li>-68: <tt class="docutils literal"><span class="pre">GRN_TOO_LARGE_OFFSET</span></tt></li>
<li>-69: <tt class="docutils literal"><span class="pre">GRN_TOO_SMALL_LIMIT</span></tt></li>
<li>-70: <tt class="docutils literal"><span class="pre">GRN_CAS_ERROR</span></tt></li>
<li>-71: <tt class="docutils literal"><span class="pre">GRN_UNSUPPORTED_COMMAND_VERSION</span></tt></li>
</ul>
</div>
<div class="section" id="see-also">
<h2>8.3.3.3. See also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference internal" href="output_format.html"><em>Output format</em></a> shows where return code is appeared in query
API response.</li>
<li><a class="reference internal" href="../../spec/gqtp.html"><em>GQTP</em></a>: GQTP protocol also uses return code as status but
it uses 2byte unsigned integer. So return codes that have negative
value are statuses that have positive value in GQTP protocol. You
can convert status value in GQTP protocol to return code by
handling it as 2byte signed integer.</li>
</ul>
</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.3.3. Return code</a><ul>
<li><a class="reference internal" href="#summary">8.3.3.1. Summary</a></li>
<li><a class="reference internal" href="#list">8.3.3.2. List</a></li>
<li><a class="reference internal" href="#see-also">8.3.3.3. See also</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="output_format.html"
                        title="previous chapter">8.3.2. Output format</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="../commands/cache_limit.html"
                        title="next chapter">8.3.4. cache_limit</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../../_sources/reference/command/return_code.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="../commands/cache_limit.html" title="8.3.4. cache_limit"
             >next</a> |</li>
        <li class="right" >
          <a href="output_format.html" title="8.3.2. Output format"
             >previous</a> |</li>
        <li><a href="../../index.html">groonga v3.0.5 documentation</a> &raquo;</li>
          <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
          <li><a href="../command.html" >8.3. Command</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2009-2013, Brazil, Inc.
    </div>
  </body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional