← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/api_scilab/help/en_US/capi/CheckLhs.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/api_scilab/help/en_US/capi/CheckLhs.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
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:html="http://www.w3.org/1999/xhtml" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="CheckLhs" xml:lang="en">
3
 
  <refnamediv>
4
 
    <refname>CheckLhs (deprecated)</refname>
5
 
    <refpurpose>
6
 
      C macro which checks the number of output arguments present in
7
 
      the calling Scilab function.
8
 
    </refpurpose>
9
 
  </refnamediv>
10
 
  <refsynopsisdiv>
11
 
    <title>Calling Sequence</title>
12
 
    <synopsis>CheckLhs(nb_min_params,nb_max_params)</synopsis>
13
 
  </refsynopsisdiv>
14
 
  <refsection>
15
 
    <title>Arguments</title>
16
 
    <variablelist>
17
 
      <varlistentry>
18
 
        <term>nb_min_params</term>
19
 
        <listitem>
20
 
          <para>
21
 
            the minimum number of output arguments which must be present
22
 
            in the calling Scilab function
23
 
          </para>
24
 
        </listitem>
25
 
      </varlistentry>
26
 
      <varlistentry>
27
 
        <term>nb_max_params</term>
28
 
        <listitem>
29
 
          <para>
30
 
            the maximum number of output arguments which must be present
31
 
            in the calling Scilab function
32
 
          </para>
33
 
        </listitem>
34
 
      </varlistentry>
35
 
    </variablelist>
36
 
  </refsection>
37
 
  <refsection>
38
 
    <title>Description</title>
39
 
    <para>
40
 
      C macro which checks the number of output arguments present in the
41
 
      calling Scilab function. You must include stack-c.h to benefit from this
42
 
      function.
43
 
    </para>
44
 
    <para>
45
 
      If the number of arguments is not between nb_min_params and
46
 
      nb_max_params, we quit the C interface (<literal>return 0;</literal>) and
47
 
      an error is returned in the Scilab console.
48
 
    </para>
49
 
    <para>
50
 
      Since <literal>CheckLhs</literal> is doing a <literal>
51
 
        return
52
 
        0;
53
 
      </literal>
54
 
      within the gateway function, it is important to call this
55
 
      macro before any memory allocation in order to avoid any memory
56
 
      leak.
57
 
    </para>
58
 
    <para>
59
 
      WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).
60
 
      This function has been replaced by <link linkend="CheckOutputArgument">CheckOutputArgument</link>.
61
 
    </para>
62
 
  </refsection>
63
 
  <refsection role="see also">
64
 
    <title>See Also</title>
65
 
    <simplelist type="inline">
66
 
      <member>
67
 
        <link linkend="CheckOutputArgument">CheckOutputArgument</link>
68
 
      </member>
69
 
    </simplelist>
70
 
  </refsection>
 
3
    <refnamediv>
 
4
        <refname>CheckLhs (deprecated)</refname>
 
5
        <refpurpose>
 
6
            C macro which checks the number of output arguments present in
 
7
            the calling Scilab function.
 
8
            <emphasis role="bold">This function is obsolete.</emphasis>
 
9
        </refpurpose>
 
10
    </refnamediv>
 
11
    <refsynopsisdiv>
 
12
        <title>Calling Sequence</title>
 
13
        <synopsis>CheckLhs(nb_min_params,nb_max_params)</synopsis>
 
14
    </refsynopsisdiv>
 
15
    <refsection>
 
16
        <title>Arguments</title>
 
17
        <variablelist>
 
18
            <varlistentry>
 
19
                <term>nb_min_params</term>
 
20
                <listitem>
 
21
                    <para>
 
22
                        the minimum number of output arguments which must be present
 
23
                        in the calling Scilab function
 
24
                    </para>
 
25
                </listitem>
 
26
            </varlistentry>
 
27
            <varlistentry>
 
28
                <term>nb_max_params</term>
 
29
                <listitem>
 
30
                    <para>
 
31
                        the maximum number of output arguments which must be present
 
32
                        in the calling Scilab function
 
33
                    </para>
 
34
                </listitem>
 
35
            </varlistentry>
 
36
        </variablelist>
 
37
    </refsection>
 
38
    <refsection>
 
39
        <title>Description</title>
 
40
        <para>
 
41
            C macro which checks the number of output arguments present in the
 
42
            calling Scilab function. You must include stack-c.h to benefit from this
 
43
            function.
 
44
        </para>
 
45
        <para>
 
46
            If the number of arguments is not between nb_min_params and
 
47
            nb_max_params, we quit the C interface (<literal>return 0;</literal>) and
 
48
            an error is returned in the Scilab console.
 
49
        </para>
 
50
        <para>
 
51
            Since <literal>CheckLhs</literal> is doing a <literal>
 
52
                return
 
53
                0;
 
54
            </literal>
 
55
            within the gateway function, it is important to call this
 
56
            macro before any memory allocation in order to avoid any memory
 
57
            leak.
 
58
        </para>
 
59
        <para>
 
60
            WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).
 
61
            This function has been replaced by <link linkend="CheckOutputArgument">CheckOutputArgument</link>.
 
62
        </para>
 
63
    </refsection>
 
64
    <refsection role="see also">
 
65
        <title>See Also</title>
 
66
        <simplelist type="inline">
 
67
            <member>
 
68
                <link linkend="CheckOutputArgument">CheckOutputArgument</link>
 
69
            </member>
 
70
        </simplelist>
 
71
    </refsection>
71
72
</refentry>