Files
doc-fr/reference/readline/functions/readline-info.xml
2021-09-24 04:13:47 +01:00

109 lines
3.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: cef062f45e1ba5691158b591381a9a9efc1e346d Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.readline-info" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>readline_info</refname>
<refpurpose>Lit ou modifie diverses variables internes de 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>
Lit/modifie diverses variables internes.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>var_name</parameter></term>
<listitem>
<para>
Un nom de variable.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
Si fourni, ce sera la nouvelle valeur à définir.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Appelée sans paramètre, <function>readline_info</function>
retourne une tableau contenant les valeurs des paramètres de
Readline. Les éléments seront indexés par les clés suivantes :
<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> et
<literal>"terminal_name"</literal>.
</para>
<para>
Si appelée avec un ou deux paramètres, l'ancienne valeur est retournée.
</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> et <parameter>value</parameter> sont désormais 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
-->