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