aErrors.h

group aErrors

Unified list of Error codes for BrainStem module Interation.

aError.h provides a unified list of error codes. These error codes apply accross all API’s. Library functions will return one of these error codes when appropriate.

Error Codes

enum aErr

The aErr enum lists the possible error codes for library calls. BrainStem commands generally return a set of unified Error codes. The API tries to be consistent and return these errors from every interaction with the stem.

Values:

enumerator aErrNone

0 - Success, no error.

enumerator aErrMemory

1 - Memory allocation.

enumerator aErrParam

2 - Invalid parameter.

enumerator aErrNotFound

3 - Not found.

enumerator aErrFileNameLength

4 - File name too long.

enumerator aErrBusy

5 - Resource busy.

enumerator aErrIO

6 - Input/Output error.

enumerator aErrMode

7 - Invalid Mode.

enumerator aErrWrite

8 - Write error.

enumerator aErrRead

9 - Read error.

enumerator aErrEOF

10 - End of file.

enumerator aErrNotReady

11 - Not ready, no bytes available.

enumerator aErrPermission

12 - Insufficient permissions.

enumerator aErrRange

13 - Value out of range.

enumerator aErrSize

14 - Invalid Size.

enumerator aErrOverrun

15 - Buffer/queue overrun.

enumerator aErrParse

16 - Parse error.

enumerator aErrConfiguration

17 - Configuration error.

enumerator aErrTimeout

18 - Timeout occurred.

enumerator aErrInitialization

19 - Initialization error.

enumerator aErrVersion

20 - Invalid version.

enumerator aErrUnimplemented

21 - Functionality unimplemented.

enumerator aErrDuplicate

22 - Duplicate request.

enumerator aErrCancel

23 - Cancelation occured, or did not complete.

enumerator aErrPacket

24 - Packet byte invalid.

enumerator aErrConnection

25 - Connection error.

enumerator aErrIndexRange

26 - Index out of range.

enumerator aErrShortCommand

27 - BrainStem command to short.

enumerator aErrInvalidEntity

28 - Invalid entity error.

enumerator aErrInvalidOption

29 - Invalid option code.

enumerator aErrResource

30 - Resource unavailable.

enumerator aErrMedia

31 - Media error.

enumerator aErrAsyncReturn

32 - Asynchronous return.

enumerator aErrUnknown

33 - Unknown error.

const char *aError_GetErrorText(aErr err)

Returns a printable error string.