Files
archived-pecl-virtualizatio…/doc/html/function.libvirt-version.html
2011-02-08 11:01:25 +01:00

119 lines
4.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 libvirt version</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.libvirt-storagevolume-lookup-by-name.html">libvirt_storagevolume_lookup_by_name</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.notes.html">Lotus Notes</a></div>
<div class="up"><a href="ref.libvirt.html">Libvirt Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.libvirt-version" class="refentry">
<div class="refnamediv">
<h1 class="refname">libvirt_version</h1>
<p class="verinfo">(php-libvirt 0.1)</p><p class="refpurpose"><span class="refname">libvirt_version</span> &mdash; <span class="dc-title">Get libvirt version</span></p>
</div>
<a name="function.libvirt-version.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><b>libvirt_version</b></span>
([ <span class="methodparam"><span class="type">string</span> <tt class="parameter">$type</tt><span class="initializer">= null</span></span>
] )</div>
<p class="para rdfs-comment">
Provides two information back, libvirt is the version of the library while type will be the version of the hypervisor type against which the library was compiled
</p>
</div>
<a name="function.libvirt-version.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">type</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Hypervisor type against which the library was compiled. If <i><tt class="parameter">type</tt></i>
is NULL, &quot;Xen&quot; is assumed.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.libvirt-version.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Associative array containing version information. It cointains these members:
</p><ul class="simplelist">
<li class="member">libvirt.release</li>
<li class="member">libvirt.major</li>
<li class="member">libvirt.minor</li>
<li class="member">type.release</li>
<li class="member">type.major</li>
<li class="member">type.minor</li>
</ul><p>
</p>
</div>
<a name="function.libvirt-version.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>libvirt_version()</b> example</b></p>
<div class="example-contents para"><p>
Get version of libvirt and xen driver.
</p></div>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /><br />&nbsp;&nbsp;&nbsp;&nbsp;$version</span><span style="color: #007700">=</span><span style="color: #0000BB">libvirt_version</span><span style="color: #007700">(</span><span style="color: #DD0000">"xen"</span><span style="color: #007700">)<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$version</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
</div>
<div class="example-contents para"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Array
(
[libvirt.release] =&gt; 0
[libvirt.minor] =&gt; 6
[libvirt.major] =&gt; 0
[type.release] =&gt; 1
[type.minor] =&gt; 0
[type.major] =&gt; 3
)
</pre></div>
</div>
</div><p>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.libvirt-storagevolume-lookup-by-name.html">libvirt_storagevolume_lookup_by_name</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.notes.html">Lotus Notes</a></div>
<div class="up"><a href="ref.libvirt.html">Libvirt Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>