<!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 API version</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.udm-alloc-agent.html">udm_alloc_agent</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.udm-cat-list.html">udm_cat_list</a></div>
<div class="up"><a href="ref.mnogosearch.html">mnoGoSearch Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.udm-api-version" class="refentry">
<div class="refnamediv">
<h1 class="refname">udm_api_version</h1>
<p class="verinfo">(PHP 4 >= 4.0.5, PHP 5 <= 5.0.5, PECL mnogosearch >= 1.0.0)</p><p class="refpurpose"><span class="refname">udm_api_version</span> — <span class="dc-title">Get mnoGoSearch API version</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.udm-api-version-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>udm_api_version</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Gets the mnoGoSearch API version.
</p>
<p class="para">
This function allows the user to identify which API functions are
available, e.g. <span class="function"><a href="function.udm-get-doc-count.html" class="function">udm_get_doc_count()</a></span> function is only
available in mnoGoSearch 3.1.11 or later.
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.udm-api-version-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
<span class="function"><strong>udm_api_version()</strong></span> returns the mnoGoSearch API version
number. E.g. if mnoGoSearch 3.1.10 API is used, this function will return
<em>30110</em>.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.udm-api-version-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4701">
<p><strong>Example #1 <span class="function"><strong>udm_api_version()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">udm_api_version</span><span style="color: #007700">() >= </span><span style="color: #0000BB">30111</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Total number of URLs in database: " </span><span style="color: #007700">. </span><span style="color: #0000BB">udm_get_doc_count</span><span style="color: #007700">(</span><span style="color: #0000BB">$udm</span><span style="color: #007700">) . </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.udm-alloc-agent.html">udm_alloc_agent</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.udm-cat-list.html">udm_cat_list</a></div>
<div class="up"><a href="ref.mnogosearch.html">mnoGoSearch Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
