<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Attaches an IP address attribute</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.radius-get-vendor-attr.html">radius_get_vendor_attr</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.radius-put-attr.html">radius_put_attr</a></div> <div class="up"><a href="ref.radius.html">Radius Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.radius-put-addr" class="refentry"> <div class="refnamediv"> <h1 class="refname">radius_put_addr</h1> <p class="verinfo">(PECL radius >= 1.1.0)</p><p class="refpurpose"><span class="refname">radius_put_addr</span> — <span class="dc-title">Attaches an IP address attribute</span></p> </div> <div class="refsect1 description" id="refsect1-function.radius-put-addr-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>radius_put_addr</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$radius_handle</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$addr</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code><span class="initializer"> = 0</span></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$tag</code></span> ]] )</div> <p class="para rdfs-comment"> Attaches an IP address attribute to the current RADIUS request. </p> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para">A request must be created via <span class="function"><a href="function.radius-create-request.html" class="function">radius_create_request()</a></span> before this function can be called.</p></p></blockquote> </div> <div class="refsect1 parameters" id="refsect1-function.radius-put-addr-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">radius_handle</code></em></span><dd> <p class="para">The RADIUS resource.</p></dd> </dt> <dt> <span class="term"><em><code class="parameter">type</code></em></span><dd> <p class="para">The attribute type.</p></dd> </dt> <dt> <span class="term"><em><code class="parameter">addr</code></em></span> <dd> <p class="para"> An IPv4 address in string form, such as <em>10.0.0.1</em>. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">options</code></em></span><dd> <p class="para">A bitmask of the attribute options. The available options include <a href="radius.constants.options.html#constant.radius-option-tagged" class="link"><strong><code>RADIUS_OPTION_TAGGED</code></strong></a> and <a href="radius.constants.options.html#constant.radius-option-salt" class="link"><strong><code>RADIUS_OPTION_SALT</code></strong></a>.</p></dd> </dt> <dt> <span class="term"><em><code class="parameter">tag</code></em></span><dd> <p class="para">The attribute tag. This parameter is ignored unless the <a href="radius.constants.options.html#constant.radius-option-tagged" class="link"><strong><code>RADIUS_OPTION_TAGGED</code></strong></a> option is set.</p></dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.radius-put-addr-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 changelog" id="refsect1-function.radius-put-addr-changelog"> <h3 class="title">Changelog</h3> <p class="para"> <table class="doctable informaltable"> <thead> <tr> <th>Version</th> <th>Description</th> </tr> </thead> <tbody class="tbody"> <tr> <td>PECL radius 1.3.0</td> <td> The <em><code class="parameter">options</code></em> and <em><code class="parameter">tag</code></em> parameters were added. </td> </tr> </tbody> </table> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.radius-get-vendor-attr.html">radius_get_vendor_attr</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.radius-put-attr.html">radius_put_attr</a></div> <div class="up"><a href="ref.radius.html">Radius Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>