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

Change language to:
English - Français - 日本語 -

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

Manual Scilab >> API Scilab > Scilab Gateway API > CheckColumn

CheckColumn

C interface function which checks if a parameter send to the C function is a column vector or not

Calling Sequence

CheckColumn(StackPos,m_var,n_var)

Arguments

StackPos

the position in the Scilab memory of the argument for which we want to perform the check (input parameter)

m_var

the number of lines of the parameter at position StackPos in the Scilab memory

n_var

the number of columns of the parameter at position StackPos in the Scilab memory

Description

C interface function which checks if a parameter send to the C function is a column vector or not. You must include stack-c.h to benefit from this function.

WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use API Scilab (the new Scilab API).

Examples

In this example, the C interface function takes one input parameters and prints the integer corresponding to the type of the variable sent as parameter in the Scilab console. If the test fails, we return from the C interface and an adequate error message is printed in the Scilab console.

#include <stack-c.h>

int sci_check_properties(char * fname)
{
  int m1, n1, l1;

  CheckRhs(1,1);

  GetRhsVar(1, "d", &m1, &n1, &l1);

  CheckColumn(1,m1,n1); // Check that first argument is a column vector

  return 0;
}
<< How to Scilab Gateway API CheckDimProp >>

Copyright (c) 2022-2023 (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:
Wed Jan 26 16:24:43 CET 2011