mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
df09208f42
This has also resulted in some previously undocumented functions being documented: there's still more that could be done there, and some of the examples are pretty minimal, but it's a start. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330790 c90b9560-bf6c-de11-be94-00142212c4b1
113 lines
3.1 KiB
XML
113 lines
3.1 KiB
XML
<?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-vendor-string" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>radius_put_vendor_string</refname>
|
|
<refpurpose>Attaches a vendor specific string attribute</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>radius_put_vendor_string</methodname>
|
|
<methodparam><type>resource</type><parameter>radius_handle</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>vendor</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 vendor specific string attribute to the current RADIUS request.
|
|
In general, <function>radius_put_vendor_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.vendor;
|
|
&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="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>radius_put_vendor_int</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
|
|
-->
|
|
|