snmp_set_valueretrieval

Specify the method how the SNMP values will be returned

&reftitle.description; `bool` `snmp_set_valueretrieval` `int` `method` SNMP_VALUE_LIBRARY
&reftitle.parameters;

`method`

- ## types

  SNMP_VALUE_LIBRARY | The return values will be as returned by the Net-SNMP library.
  SNMP_VALUE_PLAIN | The return values will be the plain value without the SNMP type hint.
  SNMP_VALUE_OBJECT | 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 `SNMP_VALUE_LIBRARY`, `SNMP_VALUE_PLAIN` is set.

&reftitle.examples;

### Using `snmp_set_valueretrieval`

    <?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
     // )

    ?>

&reftitle.changelog;

&Version; | &Description;
5.4.0 | Constants `SNMP_VALUE_PLAIN` or `SNMP_VALUE_LIBRARY` may be combined with `SNMP_VALUE_OBJECT` resulting different way of representing contents of `value` array element in return value of GET-function. If no `SNMP_VALUE_{PLAIN,LIBRARY}` constant is accompanying `SNMP_VALUE_OBJECT`, `SNMP_VALUE_LIBRARY` is used. Prior to 5.4.0 `SNMP_VALUE_OBJECT` effecively meant `SNMP_VALUE_OBJECT`|`SNMP_VALUE_PLAIN`.

&reftitle.seealso;

- `snmp_get_valueretrieval`
- snmp.constants