Source of: /manual/en/function.radius-config.php


<?php

include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';

$TOC = array();

$PARENTS = array();

include_once dirname(__FILE__) ."/toc/ref.radius.inc";

$setup = array (

  'home' => 

  array (

    0 => 'index.php',

    1 => 'PHP Manual',

  ),

  'head' => 

  array (

    0 => 'UTF-8',

    1 => 'en',

  ),

  'this' => 

  array (

    0 => 'function.radius-config.php',

    1 => 'radius_config',

  ),

  'up' => 

  array (

    0 => 'ref.radius.php',

    1 => 'Radius Functions',

  ),

  'prev' => 

  array (

    0 => 'function.radius-close.php',

    1 => 'radius_close',

  ),

  'next' => 

  array (

    0 => 'function.radius-create-request.php',

    1 => 'radius_create_request',

  ),

);

$setup["toc"] = $TOC;

$setup["parents"] = $PARENTS;

manual_setup($setup);



manual_header();

?>

<div id="function.radius-config" class="refentry">

 <div class="refnamediv">

  <h1 class="refname">radius_config</h1>

  <p class="verinfo">(PECL radius &gt;= 1.1.0)</p><p class="refpurpose"><span class="refname">radius_config</span> &mdash; <span class="dc-title">Causes the library to read the given configuration file</span></p>



 </div>



 <a name="function.radius-config.description"></a><div class="refsect1 description">

  <h3 class="title">Description</h3>

  <div class="methodsynopsis dc-description">

   <span class="type">bool</span> <span class="methodname"><b>radius_config</b></span>

    ( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$radius_handle</tt></span>

   , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$file</tt></span>

   )</div>



  <p class="para rdfs-comment">

   Before issuing any Radius requests, the library must be made aware of the

   servers it can contact. The easiest way to configure the library is to

   call <b>radius_config()</b>. <b>radius_config()</b>

   causes the library to read a configuration file whose format is described

   in <a href="http://www.freebsd.org/cgi/man.cgi?query=radius.conf" class="link external">&raquo; radius.conf</a>.

  </p>

 </div>





 <a name="function.radius-config.parameters"></a><div class="refsect1 parameters">

  <h3 class="title">Parameters</h3>

  <p class="para">

   </p><dl>



    <dt class="varlistentry">



     <span class="term"><i><tt class="parameter">radius_handle</tt></i>

</span>



     </dt><dd class="listitem">



      <p class="para">

       

      </p>

     </dd>



    

    <dt class="varlistentry">



     <span class="term"><i><tt class="parameter">file</tt></i>

</span>



     </dt><dd class="listitem">



      <p class="para">

       The pathname of the configuration file is passed as the file argument

       to <b>radius_config()</b>. The library can also be

       configured programmatically by calls to

       <a href="function.radius-add-server.php" class="function">radius_add_server()</a>.

      </p>

     </dd>



    

   </dl>

<p>

  </p>

 </div>





 <a name="function.radius-config.returnvalues"></a><div class="refsect1 returnvalues">

  <h3 class="title">Return Values</h3>

  <p class="para">

   Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.

  </p>

 </div>





 <a name="function.radius-config.seealso"></a><div class="refsect1 seealso">

  <h3 class="title">See Also</h3>

  <p class="para">

   </p><ul class="simplelist">

    <li class="member"><a href="function.radius-add-server.php" class="function" rel="rdfs-seeAlso">radius_add_server()</a> - Adds a server</li>

   </ul><p>

  </p>

 </div>



</div><?php manual_footer(); ?>
Our source is open

Source of: /manual/en/function.radius-config.php
