Error Handling

On success, these functions return S3L_SUCCESS.

These functions all check the arrays they accept as arguments. If an array argument contains an invalid or corrupted value, the function terminates and an error code indicating which value of the array handle was invalid is returned. See Appendix A of this manual for a detailed list of these error codes.

In addition, the following condition will cause the functions to terminate and return the associated code:

• S3L_ERR_ARG_DTYPE - The type of the array is invalid. It must be one of: S3L_integer, S3L_long_integer, S3L_float or S3L_double.

• S3L_ERR_ARG_AXISNUM - The axis argument has an invalid value. The correct values for axis are

  • 0 <= axis < rank of a (C/C++)

  • 0 < axis <= rank of a (F77/F90)