uTools-Manuals/docs/php/udm_get_res_param.html
2019-04-08 23:22:26 +08:00

108 lines
3.5 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Get mnoGoSearch result parameters</title>
</head>
<body class="docs"><div id="layout">
<div id="layout-content"><div id="function.udm-get-res-param" class="refentry">
<div class="refnamediv">
<h1 class="refname">udm_get_res_param</h1>
<p class="verinfo">(PHP 4 &gt;= 4.0.5, PHP 5 &lt; 5.1.0, PECL mnogosearch &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">udm_get_res_param</span> &mdash; <span class="dc-title">Get mnoGoSearch result parameters</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.udm-get-res-param-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>udm_get_res_param</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$res</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$param</code></span>
) : <span class="type">string</span></div>
<p class="para rdfs-comment">
Gets the mnoGoSearch result parameters.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.udm-get-res-param-parameters">
<h3 class="title">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">res</code></dt>
<dd>
<p class="para">
<code class="parameter">res</code> - a link to result identifier, received after
call to <span class="function"><a href="udm_find.html" class="function">udm_find()</a></span>.
</p>
</dd>
<dt>
<code class="parameter">param</code></dt>
<dd>
<p class="para">
<code class="parameter">param</code> - parameter identifier, may have the following values:
<ul class="itemizedlist">
<li class="listitem">
<span class="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.
</span>
</li>
<li class="listitem">
<span class="simpara">
UDM_PARAM_FOUND - total number of results matching the query.
</span>
</li>
<li class="listitem">
<span class="simpara">
UDM_PARAM_WORDINFO - information on the words found. E.g. search for
&quot;a good book&quot; will return &quot;a: stopword, good:5637, book: 120&quot;
</span>
</li>
<li class="listitem">
<span class="simpara">
UDM_PARAM_SEARCHTIME - search time in seconds.
</span>
</li>
<li class="listitem">
<span class="simpara">
UDM_PARAM_FIRST_DOC - the number of the first document displayed on current page.
</span>
</li>
<li class="listitem">
<span class="simpara">
UDM_PARAM_LAST_DOC - the number of the last document displayed on current page.
</span>
</li>
</ul>
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.udm-get-res-param-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
<span class="function"><strong>udm_get_res_param()</strong></span> returns result parameter value on
success, <strong><code>FALSE</code></strong> on error.
</p>
</div>
</div></div></div></body></html>