Name

CheckDims — C interface function which checks if a parameter send to the C function has the required dimensions

Calling Sequence

CheckDims(StackPos,m_var,n_var,m_required,n_required)

Parameters

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, CheckRow, CheckScalar, CheckVector, CheckOverLoad, CheckDimProp, CheckLength, CheckSameDims, CheckSquare, How to check parameters