svn: /phpdoc/en/trunk/reference/snmp/functions/ snmprealwalk.xml
| From: | Christian Hammers | Date: | Sat, 19 Feb 2011 18:49:13 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/snmp/functions/ snmprealwalk.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-7791@lists.php.net to get a copy of this message | ||
ch Sat, 19 Feb 2011 18:49:13 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=308493
Log:
Added documentation for the snmprealkwalk() function.
Changed paths:
U phpdoc/en/trunk/reference/snmp/functions/snmprealwalk.xml
Modified: phpdoc/en/trunk/reference/snmp/functions/snmprealwalk.xml
===================================================================
--- phpdoc/en/trunk/reference/snmp/functions/snmprealwalk.xml 2011-02-19 18:48:29 UTC (rev 308492)
+++ phpdoc/en/trunk/reference/snmp/functions/snmprealwalk.xml 2011-02-19 18:49:13 UTC (rev 308493)
@@ -17,10 +17,87 @@
<methodparam
choice="opt"><type>int</type><parameter>timeout</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>retries</parameter></methodparam>
</methodsynopsis>
-
- &warn.undocumented.func;
-
+ <para>
+ The <function>snmprealwalk</function> function is used to traverse over a number
+ of <acronym>SNMP</acronym> objects starting from
<parameter>object_id</parameter>
+ and return not only their values but also their object ids.
+ </para>
</refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>host</parameter></term>
+ <listitem><para>The hostname of the <acronym>SNMP</acronym> agent
(server).</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>community</parameter></term>
+ <listitem><para>The read community.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>object_id</parameter></term>
+ <listitem><para>The <acronym>SNMP</acronym> object id which precedes
the wanted one.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>timeout</parameter></term>
+ <listitem><para>The number of microseconds until the first
timeout.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>retries</parameter></term>
+ <listitem><para>The number of retries in case timeouts
occur.</para></listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns an associative array of the <acronym>SNMP</acronym> object ids and their
values on success or &false; on error.
+ In case of an error, an E_WARNING message is shown.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>Using <function>snmprealwalk</function></title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+ print_r(snmprealwalk("localhost", "public", "IF-MIB::ifName"));
+?>
+]]>
+ </programlisting>
+
+ <para>
+ The above will output something like:
+<![CDATA[
+ Array
+ (
+ [IF-MIB::ifName.1] => STRING: lo
+ [IF-MIB::ifName.2] => STRING: eth0
+ [IF-MIB::ifName.3] => STRING: eth2
+ [IF-MIB::ifName.4] => STRING: sit0
+ [IF-MIB::ifName.5] => STRING: sixxs
+ )
+]]>
+ </para>
+ </example>
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>snmpwalk</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
@@ -43,3 +120,4 @@
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
+