From e61f791a333d1b89035d7da9959babd51c12e179 Mon Sep 17 00:00:00 2001
From: Christian Hammers <ch@php.net>
Date: Sat, 19 Feb 2011 18:48:29 +0000
Subject: [PATCH] Added documentation for snmpgetnext()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@308492 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/snmp/functions/snmpgetnext.xml | 74 ++++++++++++++++++++++--
 1 file changed, 70 insertions(+), 4 deletions(-)

diff --git a/reference/snmp/functions/snmpgetnext.xml b/reference/snmp/functions/snmpgetnext.xml
index 95b4bbabaa..9b9c100aa0 100644
--- a/reference/snmp/functions/snmpgetnext.xml
+++ b/reference/snmp/functions/snmpgetnext.xml
@@ -4,7 +4,7 @@
  <refnamediv>
   <refname>snmpgetnext</refname>
   <refpurpose>
-   Fetch a SNMP object
+   Fetch the <acronym>SNMP</acronym> object which follows the given object id
   </refpurpose>
  </refnamediv>
  <refsect1 role="description">
@@ -17,10 +17,76 @@
    <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>snmpgetnext</function> function is used to read the
+   value of the <acronym>SNMP</acronym> object that follows the specified 
+   <parameter>object_id</parameter>.
+  </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 <acronym>SNMP</acronym> object value 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>snmpgetnext</function></title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$nameOfSecondInterface = snmpgetnetxt('localhost', 'public', 'IF-MIB::ifName.1';
+?>
+]]>
+    </programlisting>
+   </example>
+  </para>
+ </refsect1>
+ 
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>snmpget</function></member>
+    <member><function>snmpwalk</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
+ 
 </refentry>
 
 <!-- Keep this comment at the end of the file