Files
doc-fr/reference/fdf/functions/fdf-get-value.xml
2021-09-24 04:13:47 +01:00

126 lines
3.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a56106f69198dfe88c6084593c78a71c26b24353 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.fdf-get-value" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>fdf_get_value</refname>
<refpurpose>Retourne la valeur d'un champ FDF</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>fdf_get_value</methodname>
<methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam>
<methodparam><type>string</type><parameter>fieldname</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>which</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>
<para>
Retourne la valeur d'un champ FDF.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
Le gestionnaire de document FDF, retourné par la fonction
<function>fdf_create</function>, la fonction
<function>fdf_open</function> ou la fonction
<function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fieldname</parameter></term>
<listitem>
<para>
Nom du champ FDF, sous la forme d'une &string;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>which</parameter></term>
<listitem>
<para>
Les éléments d'un champ tableau peuvent être lus en fournissant ce
paramètre optionnel, sous la forme d'un entier dont la plus petite
valeur sera &zero;. Pour les champs qui ne sont pas des tableaux, ce paramètre
optionnel sera ignoré.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne la valeur du champ.
</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>4.3.0</entry>
<entry>
Le support des tableaux et le paramètre
<parameter>which</parameter> on été ajoutés.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_set_value</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
-->