mirror of
https://github.com/php/doc-en.git
synced 2026-04-27 01:08:09 +02:00
Gina Peter Banyard
123 lines
3.3 KiB
XML
123 lines
3.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- splitted from ./en/functions/radius.xml, last change in rev 1.9 -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.radius-put-string">
|
|
<refnamediv>
|
|
<refname>radius_put_string</refname>
|
|
<refpurpose>Attaches a string attribute</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>radius_put_string</methodname>
|
|
<methodparam><type>resource</type><parameter>radius_handle</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>type</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>value</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>tag</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<simpara>
|
|
Attaches a string attribute to the current RADIUS request. In general,
|
|
<function>radius_put_attr</function> is a more useful function for
|
|
attaching string attributes, as it is binary safe.
|
|
</simpara>
|
|
&radius.request.required;
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
&radius.parameter.handle;
|
|
&radius.parameter.attribute-type;
|
|
<varlistentry>
|
|
<term><parameter>value</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
The attribute value. This value is expected by the underlying library
|
|
to be null terminated, therefore this parameter is not binary safe.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
&radius.parameter.options;
|
|
&radius.parameter.tag;
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<simpara>
|
|
&return.success;
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>PECL radius 1.3.0</entry>
|
|
<entry>
|
|
The <parameter>options</parameter> and <parameter>tag</parameter>
|
|
parameters were added.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>radius_put_string</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
if (!radius_put_string($res, RADIUS_USER_NAME, 'billy')) {
|
|
echo 'RadiusError:' . radius_strerror($res). "\n<br />";
|
|
exit;
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><function>radius_put_int</function></member>
|
|
<member><function>radius_put_vendor_int</function></member>
|
|
<member><function>radius_put_vendor_string</function></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|