File: snmp-set-quick-print.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (119 lines) | stat: -rw-r--r-- 3,212 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.snmp-set-quick-print" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>snmp_set_quick_print</refname>
  <refpurpose>Set the value of <parameter>quick_print</parameter> within the UCD <acronym>SNMP</acronym> library
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <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 <parameter>quick_print</parameter> within the UCD <acronym>SNMP</acronym> library.  When this
   is set (1), the <acronym>SNMP</acronym> library will return 'quick printed' values.  This
   means that just the value will be printed.  When <parameter>quick_print</parameter> is not
   enabled (default) the UCD <acronym>SNMP</acronym> 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>
   By default the UCD <acronym>SNMP</acronym> 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>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>quick_print</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   Setting quick_print is often used when using the information returned
   rather then displaying it.
  </para>
  <para>  
   <example>
    <title>Using <function>snmp_set_quick_print</function></title>
    <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\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\n";
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
'Timeticks: (0) 0:00:00.00'
'0:00:00.00'
]]>
    </screen>
   </example>
  </para> 
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>snmp_get_quick_print</function></member>
   </simplelist>
  </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:"~/.phpdoc/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
-->