Scilab Website | Contribute with GitLab | Mailing list archives | ATOMS toolboxes


CheckRhs (deprecated)

C macro which checks the number of input arguments present in the calling Scilab function. This function is obsolete.

Syntax

CheckRhs(nb_min_params,nb_max_params)

Arguments

nb_min_params

The minimum number of input arguments which must be present in the calling Scilab function

nb_max_params

the maximum number of input arguments which must be present in the calling Scilab function

Description

C macro which checks the number of input arguments present in the calling Scilab function. You must include api_scilab.h to benefit from this function.

If the number of input arguments is not between nb_min_params and nb_max_params, we quit the C interface (return 0;) and an error is returned in the Scilab console.

Since CheckRhs is doing a return 0; within the gateway function, it is important to call this macro before any memory allocation in order to avoid any memory leak.

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). This function has been replaced by CheckInputArgument.

Examples

#include "api_scilab.h"

int sci_my_function(char *fname, unsigned long l)
{
/* The expected profile of the function will be:
* a = my_function(a,b,c);
*/
  CheckRhs(3,3);
  CheckLhs(0,1);

}

See also

  • CheckInputArgument — C function which checks the number of input arguments present in the calling Scilab function.
Report an issue
<< CheckLhs (deprecated) Scilab Gateway API Lhs (deprecated) >>

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:
Mon Nov 07 14:59:06 CET 2022