php-doc-en/reference/snmp/functions/snmp-set-quick-print.xml
2003-12-15 16:55:22 +00:00

90 lines
2.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/snmp.xml, last change in rev 1.2 -->
<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>
<methodsynopsis>
<type>void</type><methodname>snmp_set_quick_print</methodname>
<methodparam><type>bool</type><parameter>quick_print</parameter></methodparam>
</methodsynopsis>
<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>
<para>
Setting quick_print is often used when using the information returned
rather then displaying it.
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
snmp_set_quick_print(0);
$a = snmpget("127.0.0.1", "public", ".1.3.6.1.2.1.2.2.1.9.1");
echo "$a< br />\n";
snmp_set_quick_print(1);
$a = snmpget("127.0.0.1", "public", ".1.3.6.1.2.1.2.2.1.9.1");
echo "$a<br />\n";
?>
]]>
</programlisting>
</informalexample>
</para>
<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>
<para>
By default the UCD SNMP library returns verbose values, quick_print is
used to return only the value.
</para>
<para>
Currently strings are still returned with extra quotes, this will be
corrected in a later release.
</para>
<para>
<function>snmp_set_quick_print</function> is only available when using
the UCD SNMP library. This function is not available when using
the Windows SNMP library.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->