php man page for radius_put_string

RADIUS_PUT_STRING(3)							 1						      RADIUS_PUT_STRING(3)

radius_put_string - Attaches a string attribute

SYNOPSIS
       bool radius_put_string (resource  $radius_handle, int  $type, string  $value, [int  $options], [int  $tag])

DESCRIPTION
	Attaches  a  string attribute to the current RADIUS request. In general, radius_put_attr(3) is a more useful function for attaching string
       attributes, as it is binary safe.

       Note

	      A request must be created via radius_create_request(3) before this function can be called.

PARAMETERS
	      o $radius_handle
		-The RADIUS resource.

	      o $type
		-The attribute type.

	      o $value
		- The attribute value. This value is expected by the underlying library to be null terminated, therefore  this	parameter  is  not
		binary safe.

	      o $options
		-A bitmask of the attribute options. The available options include RADIUS_OPTION_TAGGED and RADIUS_OPTION_SALT.

	      o $tag
		-The attribute tag. This parameter is ignored unless the RADIUS_OPTION_TAGGED option is set.

RETURN VALUES
	Returns TRUE on success or FALSE on failure.

CHANGELOG
       +------------------+-----------------------------------------------+
       |     Version	  |						  |
       |		  |						  |
       |		  |		     Description		  |
       |		  |						  |
       +------------------+-----------------------------------------------+
       |PECL radius 1.3.0 |						  |
       |		  |						  |
       |		  |  The $options and $tag parameters were added. |
       |		  |						  |
       +------------------+-----------------------------------------------+
EXAMPLES
       Example #1

	      radius_put_string(3) example

	      <?php
	      if (!radius_put_string($res, RADIUS_USER_NAME, 'billy')) {
		  echo 'RadiusError:' . radius_strerror($res). "
<br />";
		  exit;
	      }
	      ?>

SEE ALSO
       radius_put_int(3), radius_put_vendor_int(3), radius_put_vendor_string(3).

PHP Documentation Group 												      RADIUS_PUT_STRING(3)