radius-put-string.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: df09208f420e1ab9f606416dc7ca46e0cf2acef0 Maintainer: takagi Status: ready -->
<refentry xml:id="function.radius-put-string" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>radius_put_string</refname>
  <refpurpose>文字列属性を設定する</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>
   文字列属性を、現在の RADIUS リクエストにアタッチします。
   一般に、文字列属性をアタッチするには
   <function>radius_put_attr</function> のほうがより便利です。
   というのも、こちらのほうはバイナリセーフだからです。
  </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>
       属性の値。
       これはヌル終端であることが期待されています。つまり、このパラメータはバイナリセーフではないということです。
      </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>
        <parameter>options</parameter> および <parameter>tag</parameter>
        が追加されました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>radius_put_string</function> の例</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
-->