* Bug #13175 fixed - Update argn() help page.
[scilab.git] / scilab / modules / functions / help / fr_FR / argn.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="argn">
3     <refnamediv>
4         <refname>argn</refname>
5         <refpurpose>nombre d'arguments d'appel d'une fonction  </refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Séquence d'appel</title>
9         <synopsis>[lhs [,rhs] ]=argn()
10             lhs=argn(1)
11             rhs=argn(2)
12         </synopsis>
13     </refsynopsisdiv>
14     <refsection>
15         <title>Description</title>
16         <para>
17             Cette fonction est utilisée à l'intérieur d'une définition de fonction.
18             Elle donne le nombre effectif (au moment de l'appel) d'arguments d'entrée <varname>rhs</varname>
19             et de sortie <varname>lhs</varname>. Elle permet d'utiliser des arguments optionnels.
20         </para>
21         <para>
22             Notez que <varname>lhs</varname> est toujours supérieur ou égal à 1. Autrement dit, même si une
23             fonction est appelée sans avoir mentionné un argument de sortie, <varname>lhs</varname> sera égal à 1.
24         </para>
25     </refsection>
26     <refsection>
27         <title>Exemples</title>
28         <programlisting role="example"><![CDATA[ 
29 function concat=maFonction(nom,option)
30   [lhs,rhs]=argn(0);
31   disp(lhs);
32   if rhs <= 1 then
33          option="mon argument optionnel";
34   end
35   if rhs == 0 then
36          error("Au moins un argument attendu");
37   end
38   concat=nom+" "+option;
39 endfunction
40  ]]></programlisting>
41     </refsection>
42     <refsection role="see also">
43         <title>Voir aussi</title>
44         <simplelist type="inline">
45             <member>
46                 <link linkend="function">function</link>
47             </member>
48             <member>
49                 <link linkend="varargin">varargin</link>
50             </member>
51         </simplelist>
52     </refsection>
53 </refentry>