CheckScalar

Arguments

StackPos

the position in the Scilab memory of the parameter 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 scalar 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);

  CheckScalar(1,m1,n1); // Check that first argument is a scalar

  return 0;
}

See Also

• CheckColumn
• CheckDims
• CheckRow
• CheckVector
• CheckOverLoad
• CheckDimProp
• CheckLength
• CheckSameDims
• CheckSquare
• How to check parameters