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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision: 315005 $ -->
<refentry xml:id="function.snmp-set-valueretrieval" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>snmp_set_valueretrieval</refname>
<refpurpose>
Specify the method how the SNMP values will be returned
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type>
<methodname>snmp_set_valueretrieval</methodname>
<methodparam>
<type>int</type>
<parameter>method</parameter>
<initializer>SNMP_VALUE_LIBRARY</initializer>
</methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>method</parameter>
</term>
<listitem>
<table>
<title>types</title>
<tgroup cols="2">
<tbody>
<row>
<entry>SNMP_VALUE_LIBRARY</entry>
<entry>The return values will be as returned by the Net-SNMP library.</entry>
</row>
<row>
<entry>SNMP_VALUE_PLAIN</entry>
<entry>The return values will be the plain value without the SNMP type hint.</entry>
</row>
<row>
<entry>SNMP_VALUE_OBJECT</entry>
<entry>
The return values will be objects with the properties "value" and "type", where the latter
is one of the SNMP_OCTET_STR, SNMP_COUNTER etc. constants. The
way "value" is returned is based on which one of constants
<constant>SNMP_VALUE_LIBRARY</constant>, <constant>SNMP_VALUE_PLAIN</constant> is set.
</entry>
</row>
</tbody>
</tgroup>
</table>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Using
<function>snmp_set_valueretrieval</function>
</title>
<programlisting role="php">
<![CDATA[
<?php
snmp_set_valueretrieval(SNMP_VALUE_LIBRARY);
$ret = snmpget('localhost', 'public', 'IF-MIB::ifName.1');
// $ret = "STRING: lo"
snmp_set_valueretrieval(SNMP_VALUE_PLAIN);
$ret = snmpget('localhost', 'public', 'IF-MIB::ifName.1');
// $ret = "lo";
snmp_set_valueretrieval(SNMP_VALUE_OBJECT);
$ret = snmpget('localhost', 'public', 'IF-MIB::ifName.1');
// stdClass Object
// (
// [type] => 4 <-- SNMP_OCTET_STR, see constants
// [value] => lo
// )
// PHP 5.4+ examples
snmp_set_valueretrieval(SNMP_VALUE_OBJECT | SNMP_VALUE_PLAIN);
$ret = snmpget('localhost', 'public', 'IF-MIB::ifName.1');
// stdClass Object
// (
// [type] => 4 <-- SNMP_OCTET_STR, see constants
// [value] => lo
// )
snmp_set_valueretrieval(SNMP_VALUE_OBJECT | SNMP_VALUE_LIBRARY);
$ret = snmpget('localhost', 'public', 'IF-MIB::ifName.1');
// stdClass Object
// (
// [type] => 4 <-- SNMP_OCTET_STR, see constants
// [value] => STRING: lo
// )
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.4.0</entry>
<entry>
<para>
Constants <constant>SNMP_VALUE_PLAIN</constant> or <constant>SNMP_VALUE_LIBRARY</constant>
may be combined with <constant>SNMP_VALUE_OBJECT</constant>
resulting different way of representing contents of <parameter>value</parameter>
array element in return value of GET-function. If no
<constant>SNMP_VALUE_{PLAIN,LIBRARY}</constant> constant is
accompanying <constant>SNMP_VALUE_OBJECT</constant>,
<constant>SNMP_VALUE_LIBRARY</constant> is used.
</para>
<para>
Prior to 5.4.0 <constant>SNMP_VALUE_OBJECT</constant> effecively meant
<constant>SNMP_VALUE_OBJECT</constant>|<constant>SNMP_VALUE_PLAIN</constant>.
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member>
<function>snmp_get_valueretrieval</function>
</member>
<member><xref linkend="snmp.constants" /></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
-->
|
