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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.udm-get-res-param">
<refnamediv>
<refname>udm_get_res_param</refname>
<refpurpose>Get mnoGoSearch result parameters</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>udm_get_res_param</methodname>
<methodparam><type>resource</type><parameter>res</parameter></methodparam>
<methodparam><type>int</type><parameter>param</parameter></methodparam>
</methodsynopsis>
<para>
Gets the mnoGoSearch result parameters.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>res</parameter></term>
<listitem>
<para>
<parameter>res</parameter> - a link to result identifier, received after
call to <function>udm_find</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>param</parameter></term>
<listitem>
<para>
<parameter>param</parameter> - parameter identifier, may have the following values:
<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>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>udm_get_res_param</function> returns result parameter value on
success, &false; on error.
</para>
</refsect1>
</refentry>
<!-- 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
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
