Scilab Website | Contribute with GitLab | Mailing list archives | ATOMS toolboxes
Scilab Online Help
6.1.0 - Português

Change language to:
English - Français - 日本語 - Русский

Please note that the recommended version of Scilab is 2025.0.0. This page might be outdated.
However, this page did not exist in the previous stable version.

Ajuda do Scilab >> API Scilab > legacy > api_scilab

api_scilab

api_scilab is the Scilab interface to read/write data from/to Scilab memory

Description

Since Scilab 5.2.0, Scilab provides a consistent, documented and easy way API.

This API provides functions to read/write data from/to Scilab memory.

It provides many advantages:

  • Management of all Scilab data types

  • Consistency over all data types

  • Error management

  • Fully documented

  • Fully tested by unitary tests

  • Straight and named access (See the call_scilab API) to variables.

  • And it will be maintained over future versions of Scilab

Usually, this API is used to extend Scilab capabilities but can be used in other contexts

  • Libraries or C/C++ functions: Many libraries have been developed on the free/Open source or proprietary markets. This library can be loaded and used in a high level language like Scilab. API Scilab provides the capabilities to interact with such libraries.

  • Scilab can be used as computing engine from a third party software. This feature is called call_scilab when Scilab is used from C/C++ code or javasci when used from Java. Access to variable is done through their names (named variable).

Note that old APIs (stackX.h) will not be available after Scilab 6.0 (included).

History

VersionDescription
5.4.0 Add some functions/macros in replacement of stack functions/macros
  • nbInputArgument

    Replaces Rhs

  • nbOutputArgument

    Replaces Lhs

  • AssignOutputVariable

    Replaces LhsVar

  • ReturnArguments

    Replaces PutLhsVar

  • CheckInputArgument

    Replaces CheckRhs

  • CheckOutputArgument

    Replaces CheckLhs

Add functions to identify list datatypes: isListType, isNamedListType, isTListType, isNamedTListType, isMListType, isNamedMListType

5.5.0 Add functions to manage handles
  • getMatrixOfHandle
  • allocMatrixOfHandle
  • createMatrixOfHandle
  • isHandleType
  • getScalarHandle
  • createScalarHandle

See also - API_Scilab

See also - API_Scilab list management

See also - call_scilab

  • Call_Scilab — call_scilab is an interface which provides the ability to call Scilab engine from C/C++ code
  • Compile and run with call_scilab — How to compile a native application based on or using Scilab
  • Matrix Management — How to manage Scilab's variable read and write process using call_scilab and api_scilab
  • Boolean Management — How to manage Scilab's boolean read and write process using call_scilab and api_scilab
  • Complex Management — How to manage Scilab's complex variable read and write process using call_scilab
  • String Management — How to manage Scilab's String read and write process using call_scilab and api_scilab
Report an issue
<< string legacy API Scilab >>

Copyright (c) 2022-2024 (Dassault Systèmes)
Copyright (c) 2017-2022 (ESI Group)
Copyright (c) 2011-2017 (Scilab Enterprises)
Copyright (c) 1989-2012 (INRIA)
Copyright (c) 1989-2007 (ENPC)
with contributors
Last updated:
Tue Feb 25 08:52:44 CET 2020