MAKELRESULT

Custom Functions > Function Definitions > MAKELRESULT

MAKELRESULT

MAKELRESULT(ERROR_NUM, ARG_NUM)

MAKELRESULT is used to assign appropriate return values to a function in the case of an error. The return value has two components: an error code and an index:

Parameter	Description
ERROR_NUM	The number of the entry, in the array of error messages, to return as the error message.
ARG_NUM	The index of the argument around which a red circle must be placed.

To create the error message table, make the following string array:

char * myErrorMessageTable[NUMBER_OF_ERRORS] =
{ 
  "interrupted",
  "insufficient memory",
  "must be real",
   etc... 
};

A call to MAKELRESULT(3,1) displays the third string, "must be real" under the first argument of the custom function.

The error message table must be registered with the CreateUserErrorMessageTable function for it to be used by MAKELRESULT.