1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
<?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-put-string" xmlns="http://docbook.org/ns/docbook">
<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>
<para>
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.
</para>
&radius.request.required;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&radius.parameter.handle;
&radius.parameter.attribute-type;
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
The attribute value. This value is expected by the underlying library
to be null terminated, therefore this parameter is not binary safe.
</para>
</listitem>
</varlistentry>
&radius.parameter.options;
&radius.parameter.tag;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<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>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<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>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<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>
</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
-->
|
