<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.snmp2-get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>snmp2_get</refname>
  <refpurpose>Fetch an <acronym>SNMP</acronym> object</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>snmp2_get</methodname>
   <methodparam><type>string</type><parameter>hostname</parameter></methodparam>
   <methodparam><type>string</type><parameter>community</parameter></methodparam>
   <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>object_id</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>timeout</parameter><initializer>-1</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>retries</parameter><initializer>-1</initializer></methodparam>
  </methodsynopsis>
  <para>
   The <function>snmp2_get</function> function is used to read the
   value of an <acronym>SNMP</acronym> object specified by the
   <parameter>object_id</parameter>.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>hostname</parameter></term>
    <listitem>
     <para>
      The <acronym>SNMP</acronym> agent.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>community</parameter></term>
    <listitem>
     <para>
      The read community.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>object_id</parameter></term>
    <listitem>
     <para>
      The <acronym>SNMP</acronym> object.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>timeout</parameter></term>
    <listitem>
     <para>
      The number of microseconds until the first timeout.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>retries</parameter></term>
    <listitem>
     <para>
      The number of times to retry if timeouts occur.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns <acronym>SNMP</acronym> object value on success or &false; on error.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Using <function>snmp2_get</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$syscontact = snmp2_get("127.0.0.1", "public", "system.SysContact.0");
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>snmp2_set</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
-->
