readline-info.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d8ba69fe4e7c835bc2b76dcd908597f75d1c65a1 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi -->
<refentry xml:id="function.readline-info" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>readline_info</refname>
  <refpurpose>種々の readline の内部変数を取得/設定する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>readline_info</methodname>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>var_name</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>string</type><type>bool</type><type>null</type></type><parameter>value</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   さまざまな readline の内部変数の取得あるいは設定を行います。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>var_name</parameter></term>
     <listitem>
      <para>
       変数の名前。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       指定した場合は、これがその設定の新しい値となります。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   パラメータを指定しないでコールした場合、この関数は readline が使用する
   すべての設定の値を配列で返します。要素の添字は次のようになります。
   <literal>done</literal>, <literal>end</literal>,
   <literal>erase_empty_line</literal>,
   <literal>library_version</literal>, <literal>line_buffer</literal>,
   <literal>mark</literal>, <literal>pending_input</literal>,
   <literal>point</literal>, <literal>prompt</literal>,
   <literal>readline_name</literal>, <literal>terminal_name</literal>。
   返される配列は、readline
   拡張モジュールをビルドするのに使われるライブラリがサポートする要素だけを含みます。
  </para>
  <para>
   ひとつあるいはふたつのパラメータを指定してコールした場合は、
   元の値が返されます。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>var_name</parameter> と <parameter>value</parameter> は、
       nullable になりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </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
-->