← 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/list_management/isListType.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/list_management/isListType.xml
11
11
 *
12
12
 -->
13
13
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="isListType" xml:lang="en">
14
 
  <refnamediv>
15
 
    <refname>isListType, isTListType, isMListType</refname>
16
 
    <refpurpose>
17
 
      Check if it is a list, mlist, tlist variable.
18
 
    </refpurpose>
19
 
  </refnamediv>
20
 
  <refsynopsisdiv>
21
 
    <title>Calling Sequence</title>
22
 
    <synopsis>int isListType(void* _pvCtx, int* _piAddress)</synopsis>
23
 
    <synopsis>int isNamedListType(void* _pvCtx, const char* _pstName)</synopsis>
24
 
    <synopsis>int isTListType(void* _pvCtx, int* _piAddress)</synopsis>
25
 
    <synopsis>int isNamedTListType(void* _pvCtx, const char* _pstName)</synopsis>
26
 
    <synopsis>int isMListType(void* _pvCtx, int* _piAddress)</synopsis>
27
 
    <synopsis>int isNamedMListType(void* _pvCtx, const char* _pstName)</synopsis>
28
 
  </refsynopsisdiv>
29
 
  <refsection>
30
 
    <title>Arguments</title>
31
 
    <variablelist>
32
 
      <varlistentry>
33
 
        <term>_pvCtx</term>
34
 
        <listitem>
35
 
          <para>
36
 
            Scilab environment pointer, pass in "pvApiCtx" provided by api_scilab.h.
37
 
          </para>
38
 
        </listitem>
39
 
      </varlistentry>
40
 
      <varlistentry>
41
 
        <term>_piAddress</term>
42
 
        <listitem>
43
 
          <para>
44
 
            Position in the Scilab memory where you want to put the variable.
45
 
          </para>
46
 
        </listitem>
47
 
      </varlistentry>
48
 
      <varlistentry>
49
 
        <term>_pstName</term>
50
 
        <listitem>
51
 
          <para>
52
 
            Name of the variable for "named" functions.
53
 
          </para>
54
 
        </listitem>
55
 
      </varlistentry>
56
 
    </variablelist>
57
 
  </refsection>
58
 
  <refsection>
59
 
    <title>Return value</title>
60
 
    <para>1 if variable is a list type, otherwise 0</para>
61
 
  </refsection>
62
 
  <refsection>
63
 
    <title>Scilab test script</title>
64
 
    <programlisting role="code_scilab"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>isListType, isTListType, isMListType</refname>
 
16
        <refpurpose>
 
17
            Check if it is a list, mlist, tlist variable.
 
18
        </refpurpose>
 
19
    </refnamediv>
 
20
    <refsynopsisdiv>
 
21
        <title>Calling Sequence</title>
 
22
        <synopsis>int isListType(void* _pvCtx, int* _piAddress)</synopsis>
 
23
        <synopsis>int isNamedListType(void* _pvCtx, const char* _pstName)</synopsis>
 
24
        <synopsis>int isTListType(void* _pvCtx, int* _piAddress)</synopsis>
 
25
        <synopsis>int isNamedTListType(void* _pvCtx, const char* _pstName)</synopsis>
 
26
        <synopsis>int isMListType(void* _pvCtx, int* _piAddress)</synopsis>
 
27
        <synopsis>int isNamedMListType(void* _pvCtx, const char* _pstName)</synopsis>
 
28
    </refsynopsisdiv>
 
29
    <refsection>
 
30
        <title>Arguments</title>
 
31
        <variablelist>
 
32
            <varlistentry>
 
33
                <term>_pvCtx</term>
 
34
                <listitem>
 
35
                    <para>
 
36
                        Scilab environment pointer, pass in "pvApiCtx" provided by api_scilab.h.
 
37
                    </para>
 
38
                </listitem>
 
39
            </varlistentry>
 
40
            <varlistentry>
 
41
                <term>_piAddress</term>
 
42
                <listitem>
 
43
                    <para>
 
44
                        Position in the Scilab memory where you want to put the variable.
 
45
                    </para>
 
46
                </listitem>
 
47
            </varlistentry>
 
48
            <varlistentry>
 
49
                <term>_pstName</term>
 
50
                <listitem>
 
51
                    <para>
 
52
                        Name of the variable for "named" functions.
 
53
                    </para>
 
54
                </listitem>
 
55
            </varlistentry>
 
56
        </variablelist>
 
57
    </refsection>
 
58
    <refsection>
 
59
        <title>Return value</title>
 
60
        <para>1 if variable is a list type, otherwise 0</para>
 
61
    </refsection>
 
62
    <refsection>
 
63
        <title>Scilab test script</title>
 
64
        <programlisting role="code_scilab"><![CDATA[ 
65
65
fileData = [
66
66
'#include <api_scilab.h>'
67
67
'#include <Scierror.h>'
116
116
'            sprintf(pstRet, ""%s"", ""unmanaged type"");'
117
117
'        }'
118
118
'    }'
119
 
'    createSingleString(pvApiCtx, nbInputArgument + 1, pstRet);'
120
 
'    AssignOutputVariable(1) = nbInputArgument + 1;'
 
119
'    createSingleString(pvApiCtx, nbInputArgument(pvApiCtx) + 1, pstRet);'
 
120
'    AssignOutputVariable(pvApiCtx, 1) = nbInputArgument(pvApiCtx) + 1;'
121
121
'    return 0;'
122
122
'}'
123
123
]
155
155
 
156
156
cd(currentPath);
157
157
]]></programlisting>
158
 
  </refsection>
 
158
    </refsection>
159
159
</refentry>