radius-get-attr.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/radius.xml, last change in rev 1.9 -->
<refentry xml:id="function.radius-get-attr" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>radius_get_attr</refname>
  <refpurpose>Extracts an attribute</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>radius_get_attr</methodname>
   <methodparam><type>resource</type><parameter>radius_handle</parameter></methodparam>
  </methodsynopsis>
  <para>
   Like Radius requests, each response may contain zero or more attributes.
   After a response has been received successfully by
   <function>radius_send_request</function>, its attributes can be extracted
   one by one using <function>radius_get_attr</function>. Each time
   <function>radius_get_attr</function> is called, it gets the next attribute
   from the current response.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &radius.parameter.handle;
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an associative array containing the attribute-type and the data, or
   error number &lt;= 0.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>radius_get_attr</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
while ($resa = radius_get_attr($res)) {

    if (!is_array($resa)) {
        printf("Error getting attribute: %s\n",  radius_strerror($res));
        exit;
    }

    $attr = $resa['attr'];
    $data = $resa['data'];
    printf("Got Attr:%d %d Bytes %s\n", $attr, strlen($data), bin2hex($data));
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>radius_put_attr</function></member>
    <member><function>radius_get_vendor_attr</function></member>
    <member><function>radius_put_vendor_attr</function></member>
    <member><function>radius_send_request</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
-->