Error handling

Most of the API functions return an error code as an output parameter to indicate if the execution succeeded or failed. The error codes are collected in an enumeration type called sci_error_t. Each value starts with the prefix SCI_ERR_. The code denoting success is SCI_ERR_OK and an application should check that each function call returns this value. SCIGetErrorString() can be used to get a description of an error at runtime.

Common error codes

Each API function specification is followed by a list of possible errors that are typical for that function. There are however common or generic errors that are not repeated every time, unless they do not have a particular meaning for that function.

• SCI_ERR_NOT_IMPLEMENTED

• SCI_ERR_ILLEGAL_FLAG

• SCI_ERR_FLAG_NOT_IMPLEMENTED

• SCI_ERR_ILLEGAL_PARAMETER

• SCI_ERR_NOSPC

• SCI_ERR_API_NOSPC

• SCI_ERR_HW_NOSPC

• SCI_ERR_SYSTEM

Functions requiring a local adapter number can generate the following errors:

• SCI_ERR_ILLEGAL_ADAPTERNO

• SCI_ERR_NO_SUCH_ADAPTERNO

Functions requiring a node identifier can generate the following errors:

• SCI_ERR_NO_SUCH_NODEID

• SCI_ERR_ILLEGAL_NODEID

Refer to sci_error_t for a full list of error codes.