[PHP-DOC] cvs: phpdoc /ja/functions mnogosearch.xml yaz.xml

[Rui Hirokawa]

hirokawa                Mon Feb 19 01:57:19 2001 EDT

  Added files:                 
    /phpdoc/ja/functions        mnogosearch.xml 

  Modified files:              
    /phpdoc/ja/functions        yaz.xml 
  Log:
  added mnogosearch.xml in japanese tree and update translation.
  
Index: phpdoc/ja/functions/yaz.xml
diff -u phpdoc/ja/functions/yaz.xml:1.4 phpdoc/ja/functions/yaz.xml:1.5
--- phpdoc/ja/functions/yaz.xml:1.4     Sun Feb 18 15:29:44 2001
+++ phpdoc/ja/functions/yaz.xml Mon Feb 19 01:57:19 2001
@@ -619,17 +619,16 @@
      </funcprototype>
     </funcsynopsis>
     <para>
-     Given a target ID this function returns and array with terms as received
-     from the target in the last Scan Response.
-     This function returns an array (0..n-1) where n is the number
-     of terms returned. Each value is a pair where first item is
-     term, second item is result-count.
-     If the <parameter>result</parameter> is given it will be modified to hold
-     additional information taken from the Scan Response:
-     <literal>number</literal> (number of entries returned),
-     <literal>stepsize</literal> (Step-size),
-     <literal>position</literal> (position of term),
-     <literal>status</literal> (Scan Status).
+     
+ターゲットIDを指定するすると、この関数は直近のスキャン時のレスポ
+     
+ンスとしてターゲットから受信した項目を配列として返します。この関
+     
+数は、配列(0..n-1)を返します。ただし、nは返された項目の数です。各
+     
+値は、最初の値が項目で、2番目の値が結果の数という組になっています。
+     
+<parameter>result</parameter>が指定された場合、この変数にはスキャ
+     
+ン時の応答からとりこまれた次のような追加情報が代入されます。
+     <literal>number</literal> (返されたエントリの数),
+     <literal>stepsize</literal> (ステップサイズ),
+     <literal>position</literal> (項目の位置),
+     <literal>status</literal> (スキャンステータス)
     </para>
    </refsect1>
   </refentry>
@@ -649,38 +648,36 @@
      </funcprototype>
     </funcsynopsis>
     <para>
-     This function configures the CCL query parser for a target
-     with definitions of access points (CCL qualifiers) and their
-     mapping to RPN. To map a specific CCL query to RPN afterwards
-     call the <function>yaz_ccl_parse</function> function.
-     Each index of the array <parameter>config</parameter> is the
-     name of a CCL field and the corresponding value holds a string
-     that specifies a mapping to RPN.
-     The mapping is a sequence of attribute-type, attribute-value
-     pairs. Attribute-type and attribute-value is separated by an equal
-     sign (<literal>=</literal>). Each pair is separated by white space.
+     
+この関数は、アクセスポイント(CCL限定辞)が定義するターゲットに関し
+     
+てCCLクエリパーサとRPNへのマッピングを設定します。特定のCCLクエリ
+     を後でRPNにマップするには、<function>yaz_ccl_parse</function>関数
+     
+をコールして下さい。配列<parameter>config</parameter>の各添字は、
+     
+CCLフィールドの名前であり、対応する値はRPNへのマッピングを指定す
+     
+る文字列を保持します。マッピングは属性型および属性値の組が並んだ
+     ものです。属性型と属性値は、等号 
+(<literal>=</literal>)で区切られ
+     ます。各組は、空白で区切られます。
     </para>
     <para>
-    <example>
-    <title>CCL configuration</title>
-    <simpara>
-     In the example below, the CCL parser is configured to support
-     three CCL fields: <literal>ti</literal>, <literal>au</literal> and
-     <literal>isbn</literal>. Each field is mapped to their BIB-1
-     equivalent. It is assumed that variable <literal>$id</literal> is a
-     target ID.
-    </simpara>
-    <programlisting>
-      $field["ti"] = "1=4";
-      $field["au"] = "1=1";
-      $field["isbn"] = "1=7";
-      yaz_ccl_conf($id,$field);
-    </programlisting>
-    </example>
+     <example>
+      <title>CCL 設定</title>
+      <simpara>
+       以下の例では、CCLパーサは<literal>ti</literal>、
+       <literal>au</literal>、<literal>isbn</literal>という3つのCCLフィー
+       
+ルドをサポートするように設定されます。各フィールドは、等価な
+       BIB-1へマップされます。 
+この例では、<literal>$id</literal>がター
+       ゲットIDであることを仮定しています。
+      </simpara>
+      <programlisting>
+       $field["ti"] = "1=4";
+       $field["au"] = "1=1";
+       $field["isbn"] = "1=7";
+       yaz_ccl_conf($id,$field);
+      </programlisting>
+     </example>
     </para>
    </refsect1>
   </refentry>
-
+  
   <refentry id="function.yaz-ccl-parse">
    <refnamediv>
     <refname>yaz_ccl_parse</refname>
@@ -697,23 +694,20 @@
      </funcprototype>
     </funcsynopsis>
     <para>
-     この関数は、CCLパーサを起動します。
-     This function invokes the CCL parser. It converts a given
-     CCL FIND query to an RPN query which may be passed to the
-     <function>yaz_search</function> function to perform a search.
-     To define a set of valid CCL fields call
-     <function>yaz_ccl_conf</function> prior to this function.
-     If the supplied <parameter>query</parameter> was successfully
-     converted to RPN, this function returns true, and the index
-     <literal>rpn</literal> of the supplied array
-     <parameter>result</parameter> holds a valid RPN query.
-     If the query could not be converted (because of invalid syntax,
-     unknown field, etc.) this function returns false and three
-     indexes are set in the resulting array to indicate the cause
-     of failure: <literal>errorcode</literal>CCL error code (integer),
-     <literal>errorstring</literal>CCL error string, and 
-     <literal>errorpos</literal>approximate position in query of failure
-     (integer is character position).
+     
+この関数は、CCLパーサを起動します。パーサは、指定したCCL 
+FINDクエ
+     
+リを検索を実行する<function>yaz_search</function>関数に指定可能な
+     
+RPNクエリに変換します。有効なCCLフィールドの組を定義するには、こ
+     の関数の前に<function>yaz_ccl_conf</function>をコールします。指定
+     
+した<parameter>query</parameter>のRPNへの変換が成功した場合、この
+     関数はtrueを返し、指定した配列<parameter>result</parameter>の添字
+     
+<literal>rpn</literal>は、有効なRPNクエリを保持します。(構文が無
+     
+効であったり、存在しないフィールドである等の理由により、)クエリが
+     
+変換できなかった場合、この関数はfalseを返し、失敗の原因を示すため
+     に返される配列に次のような3つの添字が設定されます。
+     <literal>errorcode</literal>CCL エラーコード (整数)、
+     <literal>errorstring</literal>CCLエラー文字列、
+     <literal>errorpos</literal> 
+エラーを発生したクエリのおおよその位
+     置(整数は文字の位置を整数で表したもの)
     </para>
    </refsect1>
   </refentry>

Index: phpdoc/ja/functions/mnogosearch.xml
+++ phpdoc/ja/functions/mnogosearch.xml
 <reference id="ref.mnogo">
  <title>mnoGoSearch 関数</title>
  <titleabbrev>mnoGoSearch</titleabbrev>
  <partintro>
   <simpara>
    ここで示す関数により、フリーの検索エンジン mnoGoSearch 
(旧名は
    
UdmSearch)へアクセスすることが可能となります。これらの関数を利用可
    能とするためには、オプション <option
    role="configure">--with-mnogosearch</option> により mnogosearchサ
    
ポートを指定してPHPをコンパイルする必要があります。mnogosearchのパ
    
スを指定せずにこのオプションを使用した場合、PHPはデフォルトで
    
mnogosearchが/usr/local/mnogosearchにあるものとして検索を行います。
    mnogosearchを他の場所にインストールしている場合には、
    <option role="configure">--with-mnogosearch=DIR</option>のようにそ
    のパスを指定する必要があります。
   </simpara>
   <note>
    <para>
     
PHPには、MySQLとの接続ライブラリが組み込まれており、MySQLにアクセ
     
スすることが可能です。mnoGoSearchは、この組み込みライブラリと互換
     
性がなく、通常のMySQLライブラリとの組合せでのみ動作します。このた
     め、mnoGoSearchをMySQLと組み合わせて使用する際には、PHPの
     
configureにMySQLをインストールしたディレクトリを指定する必要が
     
あります。これは、mnoGoSearchに関する設定で使用され、例えば、次の
     ようになります。
     <option role="configure">--with-mnogosearch --with-mysql=/usr</option>
    </para>
   </note>
   <simpara>
    
これらの関数を使用するには、3.1.10以降のバージョンのmnoGoSearchが
    インストールされている必要があります。
   </simpara>
   <simpara>
    mnoGoSearchに関するより詳細な情報は、<ulink
    url="&url.mnogo;">&url.mnogo;</ulink>にあります。
   </simpara>
  </partintro>

  <refentry id="function.udm-alloc-agent">
   <refnamediv>
    <refname>udm_alloc_agent</refname>
    <refpurpose>mnoGoSearch セッションを確保する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>int <function>udm_alloc_agent</function></funcdef>
      <paramdef>string <parameter>dbaddr</parameter></paramdef>
      <paramdef>string
       <parameter>
        <optional>dbmode</optional>
       </parameter>
      </paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     <function>udm_alloc_agent</function> returns mnogosearch agent
     identifier on success, <literal>FALSE</literal> on error. This function creates a
     session with database parameters.
    </para>
    <para>
     <parameter>dbaddr</parameter> - URL-style database description. Options (type, 
host, database name, port, user and password) to connect to SQL database.
     Do not matter for built-in text files support. Format: DBAddr 
DBType:[//[DBUser[:DBPass]@]DBHost[:DBPort]]/DBName/
     Currently supported DBType values are: mysql, pgsql, msql, solid, mssql, oracle, 
ibase. Actually, it does not matter for native libraries support.
     But ODBC users should specify one of supported values. If your database type is 
not supported, you may use "unknown" instead.
    </para>
    <para>
     <parameter>dbmode</parameter> - You may select SQL database mode of words 
storage. When "single" is specified, all words are stored in the same
     table. If "multi" is selected, words will be located in different tables 
depending of their lengths. "multi" mode is usually faster
     but requires more tables in database. If "crc" mode is selected, mnoGoSearch will 
store 32 bit integer
     word IDs calculated by CRC32 algorythm instead of words. This mode requres less 
disk space and it is faster comparing with "single"
     and "multi" modes. "crc-multi" uses the same storage structure with the "crc" 
mode, but also stores words in different tables depending on 
     words lengths like "multi" mode. Format: DBMode single/multi/crc/crc-multi
    </para>
    <note>
     <para>
     <parameter>dbaddr</parameter> and <parameter>dbmode</parameter> must match those 
used during indexing.
     </para>
    </note>
    <note>
     <para>
      In fact this function does not open connection to database and
      thus does not check entered login and password. Actual connection to database 
and login/password verification is done by <function>udm_find</function>.
     </para>
    </note>
   </refsect1>
  </refentry>

  <refentry id="function.udm-set-agent-param">
   <refnamediv>
    <refname>udm_set_agent_param</refname>
    <refpurpose>
     mnoGoSearch エージェントのセッションパラメータを設定する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>int <function>udm_set_agent_param</function></funcdef>
      <paramdef>int <parameter>agent</parameter></paramdef>
      <paramdef>int <parameter>var</parameter></paramdef>
      <paramdef>string <parameter>val</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     <function>udm_set_agent_param</function> returns <literal>TRUE</literal> on 
success,
     <literal>FALSE</literal> on error.  Defines mnoGoSearch session parameters.
    </para>
    <simpara>
     The following parameters and their values are available:
    </simpara>
    <itemizedlist>
     <listitem>
       <simpara>
        UDM_PARAM_PAGE_NUM - used to choose search results page number (results are 
returned by pages beginning from
    0, with UDM_PARAM_PAGE_SIZE results per page).
       </simpara>
     </listitem> 
     <listitem>
       <simpara>
        UDM_PARAM_PAGE_SIZE - number of search results displayed on one page.
       </simpara>
     </listitem> 
     <listitem>
       <simpara>
        UDM_PARAM_SEARCH_MODE - search mode. The following values available: 
UDM_MODE_ALL -
    search for all words; UDM_MODE_ANY - search for any word; UDM_MODE_BOOL - boolean 
search. See <function>udm_find</function> for details on boolean search.
       </simpara>
      </listitem> 
      <listitem>
       <simpara>
        UDM_PARAM_CACHE_MODE - turns on or off search result cache mode. When enabled, 
the search engine will store 
        search results to disk. In case a similar search is performed later, the 
engine will take results from the cache for faster performance.
        Available values: UDM_CACHE_ENABLED, UDM_CACHE_DISABLED.
       </simpara>
      </listitem> 
      <listitem>
       <simpara>
        UDM_PARAM_TRACK_MODE - turns on or off trackquery mode. Since version 3.1.2 
mnoGoSearch has a query tracking support.
        Note that tracking is implemented in SQL version only and not available in 
built-in database. 
        To use tracking, you have to create tables for tracking support. For MySQL, 
use create/mysql/track.txt. 
        When doing a search, front-end uses those tables to store query words, a 
number of found documents and current UNIX timestamp in seconds.
        Available values: UDM_TRACK_ENABLED, UDM_TRACK_DISABLED.
       </simpara>
      </listitem> 
      <listitem>
       <simpara>
        UDM_PARAM_CHARSET - defines local charset. Available values: set of charsets 
supported by mnoGoSearch,
    e.g. koi8-r, cp1251, ...
       </simpara>
      </listitem> 
      <listitem>
       <simpara>
        UDM_PARAM_STOPFILE - Defines name and path
     to stopwords file.  (There is a small difference with mnoGoSearch
     - while in mnoGoSearch if relative path or no path entered, it
     looks for this file in relation to UDM_CONF_DIR, the module looks for
     the file in relation to current path, i.e. to the path where the
     php script is executed.)
           </simpara>
          </listitem>
          <listitem>
       <simpara>
        UDM_PARAM_STOPTABLE - Load stop words from the given SQL table. You may use 
several StopwordTable commands. 
     This command has no effect when compiled without SQL database support.
           </simpara>
          </listitem>
           <listitem>
     <simpara>
         
        UDM_PARAM_WEIGHT_FACTOR - represents weight factors for specific document 
parts. Currently body, title, keywords, description, url are supported.
        To activate this feature please use degrees of 2 in *Weight commands of 
        the indexer.conf. Let's imagine that we have these weights:
        </simpara>
        <simpara>URLWeight     1</simpara>
        <simpara>BodyWeight    2</simpara>
        <simpara>TitleWeight   4</simpara>
    <simpara>KeywordWeight 8</simpara> 
    <simpara>DescWeight    16</simpara>
        <simpara>
        As far as indexer uses bit OR operation for word weights when some
        word presents several time in the same document, it is possible at search 
        time to detect word appearance in different document parts. Word which 
        appears only in the body will have 00000010 argegate weight (in binary 
notation).
        Word used in all document parts will have 00011111 aggregate weight.
        </simpara>
        <simpara>
        This parameter's value is a string of hex digits ABCDE. Each digit is a factor 
for corresponding bit in word weight. For the given above weights 
        configuration:
     </simpara>
     <simpara>E is a factor for weight 1  (URL Weight bit)</simpara>
     <simpara>D is a factor for weight 2  (BodyWeight bit)</simpara>
     <simpara>C is a factor for weight 4  (TitleWeight bit)</simpara>
     <simpara>B is a factor for weight 8  (KeywordWeight bit)</simpara>
     <simpara>A is a factor for weight 16 (DescWeight bit)</simpara>
     <simpara>
     Examples:
         </simpara>
         <simpara>
         UDM_PARAM_WEIGHT_FACTOR=00001 will search through URLs only.
         </simpara>     
         <simpara>
     UDM_PARAM_WEIGHT_FACTOR=00100 will search through Titles only.
         </simpara>     
         <simpara>
     UDM_PARAM_WEIGHT_FACTOR=11100 will search through Title,Keywords,Desctription but 
not through URL and Body.
         </simpara>
         <simpara>
     UDM_PARAM_WEIGHT_FACTOR=F9421 will search through:
      </simpara>
      <simpara>Description with factor 15  (F hex)</simpara>
      <simpara>Keywords with factor 9</simpara>
      <simpara>Title with factor  4</simpara>
      <simpara>Body with factor 2</simpara>
      <simpara>URL with factor 1</simpara>
      <simpara>
        If UDM_PARAM_WEIGHT_FACTOR variable is ommited, original weight value is
        taken to sort results. For a given above weight configuration it means
        that document description has a most big weight 16.
      </simpara>
          </listitem>
          <listitem>
       <simpara>
         UDM_PARAM_WORD_MATCH - word match. You may use this parameter to choose word 
match type. This feature works only 
         in "single" and "multi" modes using SQL based and built-in database. It does 
not work in cachemode and other modes 
         since they use word CRC and do not support substring search.
         Available values:
           </simpara>
         <simpara>UDM_MATCH_BEGIN - word beginning match;</simpara>
     <simpara>UDM_MATCH_END - word ending match;</simpara>
     <simpara>UDM_MATCH_WORD - whole word match;</simpara>
     <simpara>UDM_MATCH_SUBSTR - word substring match.</simpara>
      </listitem>  
     </itemizedlist>
    </refsect1>
  </refentry>

  <refentry id="function.udm-add-search-limit">
   <refnamediv>
    <refname>udm_add_search_limit</refname>
    <refpurpose>種々の検索の制約を設定する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>int <function>udm_add_search_limit</function></funcdef>
      <paramdef>int <parameter>agent</parameter></paramdef>
      <paramdef>int <parameter>var</parameter></paramdef>
      <paramdef>string <parameter>val</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     <function>udm_add_search_limit</function> returns <literal>TRUE</literal> on
     success, <literal>FALSE</literal> on error. Adds search restrictions.
    </para>
    <para>
     <parameter>agent</parameter> - a link to Agent,
     received after call to <function>udm_alloc_agent</function>.
     </para>
     <para>
     <parameter>var</parameter> - defines parameter, indicating limit.
     </para>
     <para>
     <parameter>val</parameter> - defines value of the current parameter.
     </para>
     <para>
     Possible <parameter>var</parameter> values:
     </para>
     <itemizedlist>
      <listitem>
      <simpara>
      UDM_LIMIT_URL - defines document URL limitations to limit search through 
subsection
          of database. It supports SQL % and _  LIKE wildcards, where % matches any 
number of characters, even zero characters,
          and _ matches exactly one character. E.g. http://my.domain.__/catalog may 
stand for http://my.domain.ru/catalog and http://my.domain.ua/catalog.
      </simpara>
     </listitem> 
     <listitem>
      <simpara>
     UDM_LIMIT_TAG - defines site TAG limitations. In indexer-conf you can assign 
specific TAGs to various sites and parts of a site. 
     Tags in mnoGoSearch 3.1.x are lines, that may contain metasymbols % and _. 
Metasymbols allow searching among groups of tags.
     E.g. there are links with tags ABCD and ABCE, and search restriction is by ABC_ - 
the search will be made among both of the tags.
      </simpara>
     </listitem>
     <listitem>
      <simpara>
      UDM_LIMIT_LANG - defines document language limitations.
      </simpara>
     </listitem>
     <listitem>
      <simpara>
      UDM_LIMIT_CAT - defines document category limitations. Categories are similar to 
tag feature, but nested. So you can have
      one category inside another and so on. You have to use two characters
          for each level. Use a hex number going from 0-F or a 36 base number going 
from 0-Z.   
          Therefore a top-level category like 'Auto' would be 01. If it has a
          subcategory like 'Ford', then it would be 01 (the parent category) and then
          'Ford' which we will give 01. Put those together and you get 0101. If 'Auto'
          had another subcategory named 'VW', then it's id would be 01 because it
          belongs to the 'Ford' category and then 02 because it's the next category.
          So it's id would be 0102. If VW had a sub category called 'Engine' then it's
          id would start at 01 again and it would get the 'VW' id 02 and 'Auto' id of
          01, making it 010201. If you want to search for sites under that category 
then you pass it
          cat=010201 in the url.
      </simpara>
     </listitem>
    </itemizedlist>
   </refsect1>
  </refentry>
  
<refentry id="function.udm-clear-search-limits">
   <refnamediv>
    <refname>udm_clear_search_limits</refname>
    <refpurpose>
     mnoGoSearch 検索に関する全ての制約をクリアする
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>int <function>udm_clear_search_limits</function></funcdef>
      <paramdef>int <parameter>agent</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     <function>udm_clear_search_limits</function> resets defined search limitations 
and returns <literal>TRUE</literal>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.udm-find">
   <refnamediv>
    <refname>udm_find</refname>
    <refpurpose>検索を実行する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>int <function>udm_find</function></funcdef>
      <paramdef>int <parameter>agent</parameter></paramdef>
      <paramdef>string <parameter>query</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     <function>udm_find</function> returns result link identifier on success,
      <literal>FALSE</literal> on error.
    </para>
    <para>
     The search itself. The first argument - session, the next one -
     query itself.  To find something just type words you want to find
     and press SUBMIT button.  For example, "mysql odbc". You should
     not use quotes " in query, they are written here only to divide a
     query from other text. mnoGoSearch will find all documents that
     contain word "mysql" and/or word "odbc".  Best documents having
     bigger weights will be displayed first.  If you use search mode
     ALL, search will return documents that contain both (or more)
     words you entered. In case you use mode ANY, the search will
     return list of documents that contain any of the words you
     entered.  If you want more advanced results you may use query
     language.  You should select "bool" match mode in the search
     from.
    </para>
    <simpara>
     mnoGoSearch understands the following boolean operators:
    </simpara>
    <simpara>
     &amp; - logical AND. For example, &quot;mysql &amp;
     odbc&quot;. mnoGoSearch will find any URLs that contain both
     &quot;mysql&quot; and &quot;odbc&quot;.
    </simpara>
    <simpara>
     | - logical OR. For example &quot;mysql|odbc&quot;. mnoGoSearch
     will find any URLs, that contain word &quot;mysql&quot; or word
     &quot;odbc&quot;.
    </simpara>
    <simpara>
     ~ - logical NOT. For example &quot;mysql &amp; ~odbc&quot;.
     mnoGoSearch will find URLs that contain word &quot;mysql&quot;
     and do not contain word &quot;odbc&quot; at the same time. Note
     that ~ just excludes given word from results.  Query
     &quot;~odbc&quot; will find nothing!
    </simpara>
    <simpara>
     () - group command to compose more complex queries.  For example
     &quot;(mysql | msql) &amp; ~postgres&quot;.  Query language is
     simple and powerful at the same time. Just consider query as
     usual boolean expression.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.udm-get-res-param">
   <refnamediv>
    <refname>udm_get_res_param</refname>
    <refpurpose>mnoGoSearch 結果パラメータを取得する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>string <function>udm_get_res_param</function></funcdef>
      <paramdef>int <parameter>res</parameter></paramdef>
      <paramdef>int <parameter>param</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     <function>udm_get_res_param</function> returns result parameter
     value on success, <literal>FALSE</literal> on error.
    </para>
    <para>
     <parameter>res</parameter> - a link to result identifier,
     received after call to <function>udm_find</function>.
    </para>
    <para>
     <parameter>param</parameter> - parameter identifier, may have the
     following values:
    </para>
    <itemizedlist>
      <listitem>
      <simpara>
       UDM_PARAM_NUM_ROWS - number of received found links on the current page.  It is 
equal to
       UDM_PARAM_PAGE_SIZE for all search pages, on the last page - the rest of links.
      </simpara>
     </listitem> 
     <listitem>
      <simpara>
       UDM_PARAM_FOUND - total number of results matching the query.
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       UDM_PARAM_WORDINFO - information on the words found. E.g. search for "a good 
book" will return "a: stopword, good:5637, book: 120"
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       UDM_PARAM_SEARCHTIME - search time in seconds.
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       UDM_PARAM_FIRST_DOC - the number of the first document displayed on current 
page.
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       UDM_PARAM_LAST_DOC - the number of the last document displayed on current page.
      </simpara>
     </listitem>
    </itemizedlist>
   </refsect1>
  </refentry>

  <refentry id="function.udm-get-res-field">
   <refnamediv>
    <refname>udm_get_res_field</refname>
    <refpurpose>mnoGoSearch 結果フィールドを取得する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>string <function>udm_get_res_field</function></funcdef>
      <paramdef>int <parameter>res</parameter></paramdef>
      <paramdef>int <parameter>row</parameter></paramdef>
          <paramdef>int <parameter>field</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     <function>udm_get_res_field</function> returns result field value on success, 
<literal>FALSE</literal> on error.
    </para>
    <para>
     <parameter>res</parameter> - a link to result identifier,
     received after call to <function>udm_find</function>.
    </para>
    <para>
     <parameter>row</parameter> - the number of the link on the current page. May have 
values from 0 to 
     <parameter>UDM_PARAM_NUM_ROWS</parameter>.
    </para>
    <para>
     <parameter>field</parameter> - field identifier, may have the following values:
    </para>
    <itemizedlist>
     <listitem>
      <simpara>
       UDM_FIELD_URL - document URL field
      </simpara>
     </listitem> 
     <listitem>
      <simpara>
       UDM_FIELD_CONTENT - document Content-type field (for example, text/html).
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       UDM_FIELD_TITLE - document title field.
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       UDM_FIELD_KEYWORDS - document keywords field (from META KEYWORDS tag).
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       UDM_FIELD_DESC - document description field (from META DESCRIPTION tag).
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       UDM_FIELD_TEXT - document body text (the first couple of lines to give an idea
         of what the document is about).
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       UDM_FIELD_SIZE - document size.
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       UDM_FIELD_URLID - unique URL ID of the link.
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       UDM_FIELD_RATING  - page rating (as calculated by mnoGoSearch).
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       UDM_FIELD_MODIFIED - last-modified field in unixtime format.
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       UDM_FIELD_ORDER - the number of the current document in set of found documents.
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       UDM_FIELD_CRC - document CRC.
      </simpara>
     </listitem>
    </itemizedlist>
   </refsect1>
  </refentry>

  <refentry id="function.udm-free-res">
   <refnamediv>
    <refname>udm_free_res</refname>
    <refpurpose>mnoGoSearch 結果を開放する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>int <function>udm_free_res</function></funcdef>
      <paramdef>int <parameter>res</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     <function>udm_free_res</function> returns <literal>TRUE</literal> on success, 
<literal>FALSE</literal> on error.
    </para>
    <para>
     <parameter>res</parameter> - a link to result identifier,
     received after call to <function>udm_find</function>.
    </para>
    <para>
     Freeing up memory allocated for results.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.udm-free-agent">
   <refnamediv>
    <refname>udm_free_agent</refname>
    <refpurpose>mnoGoSearch セッションを開放する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>int <function>udm_free_agent</function></funcdef>
      <paramdef>int <parameter>agent</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     <function>udm_free_agent</function> returns <literal>TRUE</literal> on success, 
<literal>FALSE</literal> on error.
    </para>
    <para>
     <parameter>agent</parameter> - link to agent identifier, received
     after call to <function>udm_alloc_agent</function>.
    </para>
    <para>
     Freeing up memory allocated for agent session.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.udm-errno">
   <refnamediv>
    <refname>udm_errno</refname>
    <refpurpose>mnoGoSearch エラー番号を取得する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>int <function>udm_errno</function></funcdef>
      <paramdef>int <parameter>agent</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     <function>udm_errno</function> returns mnoGoSearch error number,
     zero if no error.
    </para>
    <para>
     <parameter>agent</parameter> - link to agent identifier, received
     after call to <function>udm_alloc_agent</function>.
    </para>
    <para>
     Receiving numeric agent error code.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.udm-error">
   <refnamediv>
    <refname>udm_error</refname>
    <refpurpose>mnoGoSearch エラーメッセージを得る</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>string <function>udm_error</function></funcdef>
      <paramdef>int <parameter>agent</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     <function>udm_error</function> は、mnoGoSearch エラーメッセージを
     返します。エラーがない場合には、空の文字列を返します。
    </para>
    <para>
     <parameter>agent</parameter> は、エージェントIDへのリンクであり、
     <function>udm_alloc_agent</function>をコールした際に得られたもの
     です。
    </para>
    <para>
     エージェントエラーメッセージを得ます。
    </para>
   </refsect1>
  </refentry>
 </reference>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->