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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.udm-api-version">
<refnamediv>
<refname>udm_api_version</refname>
<refpurpose>Get mnoGoSearch API version</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>udm_api_version</methodname>
<void/>
</methodsynopsis>
<para>
Gets the mnoGoSearch API version.
</para>
<para>
This function allows the user to identify which API functions are
available, e.g. <function>udm_get_doc_count</function> function is only
available in mnoGoSearch 3.1.11 or later.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>udm_api_version</function> returns the mnoGoSearch API version
number. E.g. if mnoGoSearch 3.1.10 API is used, this function will return
<literal>30110</literal>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>udm_api_version</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
if (udm_api_version() >= 30111) {
echo "Total number of URLs in database: " . udm_get_doc_count($udm) . "<br />\n";
}
?>
]]>
</programlisting>
</example>
</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:"~/.phpdoc/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
-->
|
