<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2015 - Scilab Enterprises - Antoine ELIAS
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="api_types" xml:lang="en">
    <refname>API types</refname>
    <para>This page lists all types used by API Scilab.</para>
    <refsection id="api_types_scilabEnv">
        <refname>scilabEnv</refname>
        <refpurpose>This a pointer of internal information provided by Scilab engine, you just have to forwarding it to API function.</refpurpose>
        <para>Like pvApiCtx before, please to do use it. You may have to chance its structure at any moment.</para>
    </refsection>
    <refsection id="api_types_scilabVar">
        <refname>scilabVar</refname>
        <refpurpose>It is the type of Scilab variable in API Scilab.</refpurpose>
        <para>Each API Scilab that read or write in Scilab varaible use it to reference a variable.</para>
    </refsection>
    <refsection id="api_types_scilabStatus">
        <refname>scilabStatus</refname>
        <refpurpose>scilabStatus is used by API Scilab to provide a status of execution.</refpurpose>
        <para>It is a enum type: </para>
        <programlisting role="code_gateway">
            <![CDATA[
typedef enum __SCILAB_STATUS__
{
    STATUS_OK = 0,
    STATUS_ERROR = 1
}scilabStatus;
            ]]>
        </programlisting>
    </refsection>
    <refsection id="api_types_scilabOpt">
        <refname>scilabOpt</refname>
        <refpurpose>It is a list of optional arguments given in the call.</refpurpose>
        <para>
            You may use
            <link linkend="api_optional_scilab_getOptional">
                <varname>scilab_getOptional</varname>
            </link>
            to retrieve optional values.
        </para>
    </refsection>
</refentry>
