CVS update: php3/doc/functions

Date: Saturday May 22, 1999 @ 3:42 Author: mhjack Update of /repository/php3/doc/functions In directory php:/tmp/cvs-serv24610 Modified Files: snmp.sgml Log Message: Removed documentation on snmprealwalk(), this function is replaced by snmpwalkiod(). Also added documentation on snmp_get_quick_print() and snmp_set_quick_print(). Index: php3/doc/functions/snmp.sgml diff -u php3/doc/functions/snmp.sgml:1.9 php3/doc/functions/snmp.sgml:1.10 --- php3/doc/functions/snmp.sgml:1.9 Sat Apr 3 02:43:02 1999 +++ php3/doc/functions/snmp.sgml Sat May 22 03:42:58 1999 @@ -100,16 +100,16 @@ </refentry> - <refentry id="function.snmprealwalk"> + <refentry id="function.snmpwalkoid"> <refnamediv> - <refname>snmprealwalk</refname> + <refname>snmpwalkoid</refname> <refpurpose>Query for a tree of information about a network entity </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> - <funcdef>array <function>snmprealwalk</function></funcdef> + <funcdef>array <function>snmpwalkoid</function></funcdef> <paramdef>string <parameter>hostname</parameter></paramdef> <paramdef>string <parameter>community</parameter></paramdef> <paramdef>string <parameter>object_id</parameter></paramdef> @@ -125,7 +125,7 @@ as root and false on error. <para> - <function>snmprealwalk</function> function is used to read all + <function>snmpwalkoid</function> function is used to read all object ids and their respective values from an SNMP agent specified by the hostname. Community specifies the read <parameter>community</parameter> for that agent. A null @@ -136,13 +136,13 @@ returned. <para> - The existence of <function>snmprealwalk</function> and + The existence of <function>snmpwalkoid</function> and <function>snmpwalk</function> has historical reasons. Both functions are provided for backward compatibility. <informalexample> <programlisting role="php"> -$a = snmprealwalk("127.0.0.1", "public", ""); +$a = snmpwalkoid("127.0.0.1", "public", ""); </programlisting> </informalexample> @@ -162,7 +162,105 @@ </refsect1> </refentry> + + <refentry id="function.snmp_get_quick_print"> + <refnamediv> + <refname>snmp_get_quick_print</refname> + <refpurpose>Fetch the current value of the UCD library's quick_print setting + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>boolean <function>snmp_get_quick_print</function></funcdef> + <paramdef>void <parameter></parameter></paramdef> + </funcsynopsis> + + <para> + Returns the current value stored in the UCD Library for quick_print. + quick_print is off by default. + + <informalexample> + <programlisting role="php"> +$quickprint = snmp_get_quick_print(); + </programlisting> + </informalexample> + + <para> + Above function call would return 0 (false) if quick_print is on, and 1 + (true) if quick_print is on. + + <para> + <function>snmp_get_quick_print</function> is only available when using + the UCD SNMP library. This function is not applicable to Windows NT. + + <para> + See: <function>snmp_set_quick_print</function> for a description of + what quick_print actually does. + + </refsect1> + </refentry> + + + </reference> + + + <refentry id="function.snmp_set_quick_print"> + <refnamediv> + <refname>snmp_set_quick_print</refname> + <refpurpose>Set the value of quick_print within the UCD SNMP library. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>snmp_set_quick_print</function></funcdef> + <paramdef>boolean <parameter>quick_print</parameter></paramdef> + </funcsynopsis> + + <para> + Sets the value of quick_print within the UCD SNMP library. When this + is set (1), the SNMP library will return 'quick printed' values. This + means that just the value will be printed. When quick_print is not + enabled (default) the UCD SNMP library prints extra information + including the type of the value (i.e. IpAddress or OID). Additionally, + if quick_print is not enabled, the library prints additional hex values + for all strings of three characters or less. + + <para> + Setting quick_print is often used when using the information returned + rather then displaying it. + + <informalexample> + <programlisting role="php"> +snmp_set_quick_print(0); +$a = snmpget("207.227.236.1", "public", ".1.3.6.1.2.1.2.2.1.9.1"); +echo "$a<BR>\n"; +snmp_set_quick_print(1); +$a = snmpget("207.227.236.1", "public", ".1.3.6.1.2.1.2.2.1.9.1"); +echo "$a<BR>\n"; + </programlisting> + </informalexample> + + <para> + The first value printed might be: 'Timeticks: (0) 0:00:00.00', whereas + with quick_print enabled, just '0:00:00.00' would be printed. + + <para> + By default the UCD SNMP library returns verbose values, quick_print is + used to return only the value. + + <para> + Currently strings are still returned with extra quotes, this will be + corrected in a later release. + + <para> + <function>snmp_set_quick_print</function> is only available when using + the UCD SNMP library. This function is not applicable to Windows NT. + + </refsect1> + </refentry> <!-- Keep this comment at the end of the file -- PHP Development Mailing List http://www.php.net/ To unsubscribe send an empty message to php-dev-unsubscribe@lists.php.net For help: php-dev-help@lists.php.net