CheckDims

Arguments

StackPos

the position in the Scilab memory of the parameter for which we want to know the type (input parameter)

m_var

the number of lines of the parameter at position StackPos in the Scilab memory (input parameter)

n_var

the number of columns of the parameter at position StackPos in the Scilab memory (input parameter)

m_required

the required number of lines (input parameter)

n_required

the required number of columns (input parameter)

Description

C interface function which checks if a parameter send to the C function has the required dimensions. You must include stack-c.h to benefit from this function. If the test fails, we return from the C interface and an adequate error message is printed in the Scilab console.

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

#include <stack-c.h>

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

  CheckRhs(1,1);

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

  CheckDims(1,m1,n1,1,4); // Check that argument is a 1x4 matrix

  return 0;
}

See Also

• CheckColumn — C interface function which checks if a parameter send to the C function is a column vector or not
• CheckRow — C interface function which checks if a parameter send to the C function is a row vector or not
• CheckScalar — C interface function which checks if a parameter send to the C function is a scalar or not
• CheckVector — C interface function which checks if a parameter send to the C function is a vector (column or row) or not
• CheckOverLoad — C gateway function which tells Scilab to look for another overloaded function
• CheckDimProp — C interface function which checks the comatibility between 2 arguments send to the C function
• CheckLength — C interface function which checks the length of a vector send as a parameter to the C function
• CheckSameDims — C interface function which checks if two parameters send to the C function have the same size
• CheckSquare — C interface function which checks if a parameter send to the C function is a square matrix or not
• How to check parameters — how to check parameter send to an interface using the C gateway functions