Version

Appendix A

Error Summary

: Introduction
: Alphabetical Error Summary
: Numerical Error Summary

Introduction

This appendix provides a summary of ADI service error codes.
The ADI service error codes are presented in two tables: Alphabetically by error code name, including a description. Numerically by hex number, decimal number, and error name.
All ADI service functions return either SUCCESS or an error code. If the return code is not SUCCESS (0), it is an error code indicating that the function has failed and the reason for the failure.
ADI service error codes are defined in the include file adidef.h and ctaerr.h. The error codes are prefixed with ADIERR_ or CTAERR_.
For a complete listing of CTAERR codes, refer to the CT Access Developer's Reference Manual.
Asynchronous functions return SUCCESS if the input arguments and context state are valid for the given function and if the ADI service sent the command to the hardware providing the service. SUCCESS, in this case, means the function was initiated and a DONE event will be generated for the function.
A DONE event is a CT Access event informing the application that an asynchronous function has completed processing. DONE event codes are in the form ADI_function_DONE where function is the completed function (for example, PLAY, RECORD, COLLECTION).
An asynchronous function may return SUCCESS to the application when invoked and the function can later fail on the board. If a board detects an error when running a function, CT Access delivers a DONE event to the application and the event value field contains an error code.

Alphabetical Error Summary

The following table is an alphabetical listing of ADI service errors:

Error Name

Hex

Decimal

Description

ADIERR_CANNOT_CREATE_CHANNEL

0x00010006

65542

Unable to create a channel to the board due to either board or driver limitations.

ADIERR_INVALID_CALL_STATE

0x00010005

65541

The function is not valid in the current call state. For example, many functions require the call to be in the ADI_CC_STATE_CONNECTED state.

ADIERR_INVALID_QUEUEID

0x00010002

65538

Bad queue or driver ID.

ADIERR_NO_DSP_PORT

0x00010007

65543

No input or output stream for requested function.

ADIERR_NO_DSP_RESOURCES

0x00010008

65544

There are not enough free DSP resources to run the requested function.

ADIERR_NOT_ENOUGH_RESOURCES

0x0001000a

65546

Unable to obtain port resource from on-board resource management. If this error occurs when starting a protocol on an AG Quad T/E, set mediamask in ADI.START.callctl to 0 (NCC users set mediamask in NCC.X.ADI_START to 0) or configure CCMODE=NONE.

ADIERR_PLAYREC_ACCESS

0x00010001

65537

The user callback routine for playing or recording returned a value other than SUCCESS or ADI_PLAY_LAST_BUFFER.

ADIERR_TOO_MANY_BUFFERS

0x00010004

65540

Attempted to submit a play or record buffer with two buffers pending.

ADIERR_UNKNOWN_BOARDTYPE

0x00010003

65539

The board type is unrecognized (adiGetBoardSlots).

CTAERR_BAD_ARGUMENT

0x00000007

7

A function argument had an invalid value or a required pointer argument was NULL.

CTAERR_BAD_SIZE

0x0000000B

11

A size argument was too small to receive a data structure, or a play or record buffer was not a multiple of the framesize for the specified encoding.

CTAERR_BOARD_ERROR

0x00000003

3

An unexpected error occurred on the board. In most cases, there will also be an ADIEVN_BOARD_ERROR event, which will contain the board error code.

CTAERR_DRIVER_OPEN_FAILED

0x00000014

20

The driver open failed because either the driver was not installed or the maximum number of opens has been exceeded.

CTAERR_DRIVER_RECEIVE_FAILED

0x00000016

22

An error occurred retrieving an event from the driver or no events were queued in the driver.

CTAERR_DRIVER_SEND_FAILED

0x00000017

23

An error was returned by the driver in sending a message to the board. This error will occur if the board has been reset.

CTAERR_DRIVER_VERSION

0x00000015

21

The driver does not support the requested function.

CTAERR_FATAL

0x00000002

2

An internal error occurred in the CT Access library. Contact NMS.

CTAERR_FUNCTION_ACTIVE

0x0000000F

15

An attempt was made to start an asynchronous function that is already started. Also returned if an attempt was made to get a digit or flush the digit queue while collecting digits.

CTAERR_FUNCTION_NOT_ACTIVE

0x0000000E

14

An attempt was made to stop or modify a function that was not running. This error will also occur if a CC function is called when NCC is active.

CTAERR_FUNCTION_NOT_AVAIL

0x0000000D

13

Either the necessary .dsp or .tcp file has not been downloaded to the board, or the requested function required a service that is reserved for use by call control; or a requested call control operation is not available with the current protocol.

CTAERR_INVALID_BOARD

0x0000001A

26

The specified board number has not been successfully configured.

CTAERR_INVALID_CTAHD

0x00000005

5

The context handle is invalid.

CTAERR_INVALID_SEQUENCE

0x00000013

19

Either an attempt was made to stop a function that is already being stopped; or a call control function was called before receiving a response to the previous call control command; or a play or record buffer was submitted when it was not expected.

CTAERR_INVALID_STATE

0x0000000C

12

The function is not valid in the current port state. For example, most functions require the port to be in the ADI_STATE_STARTED state, which is entered after starting a trunk protocol.

CTAERR_LOCK_TIMEOUT

0x0000001D

29

A thread lock timed out.

CTAERR_NOT_FOUND

0x0000000A

10

The specified parameter does not exist.

CTAERR_NOT_IMPLEMENTED

0x00000009

9

Function was not implemented. (This error code is reserved for future use.)

CTAERR_OUTPUT_ACTIVE

0x0000001B

27

Either open port failed because the stream and slot are already opened on another port; or an output operation such as play failed because there is another active output function.

CTAERR_OUT_OF_MEMORY

0x00000006

6

Unable to allocate memory for driver or port context, for play or record buffers, or for temporary storage. When this error occurs in a DONE event, it may mean that there was insufficient memory on the board.

CTAERR_OUT_OF_RESOURCES

0x00000008

8

Unable to create shared resources.

CTAERR_SHAREMEM_ACCESS

0x00000010

16

Failed accessing shared memory.

Error Name	Hex	Decimal	Description
ADIERR_CANNOT_CREATE_CHANNEL	0x00010006	65542	Unable to create a channel to the board due to either board or driver limitations.
ADIERR_INVALID_CALL_STATE	0x00010005	65541	The function is not valid in the current call state. For example, many functions require the call to be in the ADI_CC_STATE_CONNECTED state.
ADIERR_INVALID_QUEUEID	0x00010002	65538	Bad queue or driver ID.
ADIERR_NO_DSP_PORT	0x00010007	65543	No input or output stream for requested function.
ADIERR_NO_DSP_RESOURCES	0x00010008	65544	There are not enough free DSP resources to run the requested function.
ADIERR_NOT_ENOUGH_RESOURCES	0x0001000a	65546	Unable to obtain port resource from on-board resource management. If this error occurs when starting a protocol on an AG Quad T/E, set `mediamask` in ADI.START.callctl to 0 (NCC users set `mediamask` in NCC.X.ADI_START to 0) or configure `CCMODE=NONE`.
ADIERR_PLAYREC_ACCESS	0x00010001	65537	The user callback routine for playing or recording returned a value other than SUCCESS or ADI_PLAY_LAST_BUFFER.
ADIERR_TOO_MANY_BUFFERS	0x00010004	65540	Attempted to submit a play or record buffer with two buffers pending.
ADIERR_UNKNOWN_BOARDTYPE	0x00010003	65539	The board type is unrecognized (adiGetBoardSlots).
CTAERR_BAD_ARGUMENT	0x00000007	7	A function argument had an invalid value or a required pointer argument was NULL.
CTAERR_BAD_SIZE	0x0000000B	11	A size argument was too small to receive a data structure, or a play or record buffer was not a multiple of the framesize for the specified encoding.
CTAERR_BOARD_ERROR	0x00000003	3	An unexpected error occurred on the board. In most cases, there will also be an ADIEVN_BOARD_ERROR event, which will contain the board error code.
CTAERR_DRIVER_OPEN_FAILED	0x00000014	20	The driver open failed because either the driver was not installed or the maximum number of opens has been exceeded.
CTAERR_DRIVER_RECEIVE_FAILED	0x00000016	22	An error occurred retrieving an event from the driver or no events were queued in the driver.
CTAERR_DRIVER_SEND_FAILED	0x00000017	23	An error was returned by the driver in sending a message to the board. This error will occur if the board has been reset.
CTAERR_DRIVER_VERSION	0x00000015	21	The driver does not support the requested function.
CTAERR_FATAL	0x00000002	2	An internal error occurred in the CT Access library. Contact NMS.
CTAERR_FUNCTION_ACTIVE	0x0000000F	15	An attempt was made to start an asynchronous function that is already started. Also returned if an attempt was made to get a digit or flush the digit queue while collecting digits.
CTAERR_FUNCTION_NOT_ACTIVE	0x0000000E	14	An attempt was made to stop or modify a function that was not running. This error will also occur if a CC function is called when NCC is active.
CTAERR_FUNCTION_NOT_AVAIL	0x0000000D	13	Either the necessary `.dsp` or `.tcp` file has not been downloaded to the board, or the requested function required a service that is reserved for use by call control; or a requested call control operation is not available with the current protocol.
CTAERR_INVALID_BOARD	0x0000001A	26	The specified board number has not been successfully configured.
CTAERR_INVALID_CTAHD	0x00000005	5	The context handle is invalid.
CTAERR_INVALID_SEQUENCE	0x00000013	19	Either an attempt was made to stop a function that is already being stopped; or a call control function was called before receiving a response to the previous call control command; or a play or record buffer was submitted when it was not expected.
CTAERR_INVALID_STATE	0x0000000C	12	The function is not valid in the current port state. For example, most functions require the port to be in the ADI_STATE_STARTED state, which is entered after starting a trunk protocol.
CTAERR_LOCK_TIMEOUT	0x0000001D	29	A thread lock timed out.
CTAERR_NOT_FOUND	0x0000000A	10	The specified parameter does not exist.
CTAERR_NOT_IMPLEMENTED	0x00000009	9	Function was not implemented. (This error code is reserved for future use.)
CTAERR_OUTPUT_ACTIVE	0x0000001B	27	Either open port failed because the stream and slot are already opened on another port; or an output operation such as play failed because there is another active output function.
CTAERR_OUT_OF_MEMORY	0x00000006	6	Unable to allocate memory for driver or port context, for play or record buffers, or for temporary storage. When this error occurs in a DONE event, it may mean that there was insufficient memory on the board.
CTAERR_OUT_OF_RESOURCES	0x00000008	8	Unable to create shared resources.
CTAERR_SHAREMEM_ACCESS	0x00000010	16	Failed accessing shared memory.

Numerical Error Summary

The following table is a list of ADI service errors in numerical order: Hex Decimal Error Name 0x00000002 2 CTAERR_FATAL 0x00000003 3 CTAERR_BOARD_ERROR 0x00000005 5 CTAERR_INVALID_CTAHD 0x00000006 6 CTAERR_OUT_OF_MEMORY 0x00000007 7 CTAERR_BAD_ARGUMENT 0x00000008 8 CTAERR_OUT_OF_RESOURCES 0x00000009 9 CTAERR_NOT_IMPLEMENTED 0x0000000A 10 CTAERR_NOT_FOUND 0x0000000B 11 CTAERR_BAD_SIZE 0x0000000C 12 CTAERR_INVALID_STATE 0x0000000D 13 CTAERR_FUNCTION_NOT_AVAIL 0x0000000E 14 CTAERR_FUNCTION_NOT_ACTIVE 0x0000000F 15 CTAERR_FUNCTION_ACTIVE 0x00000010 16 CTAERR_SHAREMEM_ACCESS 0x00000013 19 CTAERR_INVALID_SEQUENCE 0x00000014 20 CTAERR_DRIVER_OPEN_FAILED 0x00000015 21 CTAERR_DRIVER_VERSION 0x00000016 22 CTAERR_DRIVER_RECEIVE_FAILED 0x00000017 23 CTAERR_DRIVER_SEND_FAILED 0x0000001A 26 CTAERR_INVALID_BOARD 0x0000001B 27 CTAERR_OUTPUT_ACTIVE 0x0000001D 29 CTAERR_LOCK_TIMEOUT 0x00010001 65537 ADIERR_PLAYREC_ACCESS 0x00010002 65538 ADIERR_INVALID_QUEUEID 0x00010003 65539 ADIERR_UNKNOWN_BOARDTYPE 0x00010004 65540 ADIERR_TOO_MANY_BUFFERS 0x00010005 65541 ADIERR_INVALID_CALL_STATE 0x00010006 65542 ADIERR_CANNOT_CREATE_CHANNEL 0x00010007 65543 ADIERR_NO_DSP_PORT 0x00010008 65544 ADIERR_NO_DSP_RESOURCES 0x0001000a 65546 ADIERR_NOT_ENOUGH_RESOURCES

Hex	Decimal	Error Name
0x00000002	2	CTAERR_FATAL
0x00000003	3	CTAERR_BOARD_ERROR
0x00000005	5	CTAERR_INVALID_CTAHD
0x00000006	6	CTAERR_OUT_OF_MEMORY
0x00000007	7	CTAERR_BAD_ARGUMENT
0x00000008	8	CTAERR_OUT_OF_RESOURCES
0x00000009	9	CTAERR_NOT_IMPLEMENTED
0x0000000A	10	CTAERR_NOT_FOUND
0x0000000B	11	CTAERR_BAD_SIZE
0x0000000C	12	CTAERR_INVALID_STATE
0x0000000D	13	CTAERR_FUNCTION_NOT_AVAIL
0x0000000E	14	CTAERR_FUNCTION_NOT_ACTIVE
0x0000000F	15	CTAERR_FUNCTION_ACTIVE
0x00000010	16	CTAERR_SHAREMEM_ACCESS
0x00000013	19	CTAERR_INVALID_SEQUENCE
0x00000014	20	CTAERR_DRIVER_OPEN_FAILED
0x00000015	21	CTAERR_DRIVER_VERSION
0x00000016	22	CTAERR_DRIVER_RECEIVE_FAILED
0x00000017	23	CTAERR_DRIVER_SEND_FAILED
0x0000001A	26	CTAERR_INVALID_BOARD
0x0000001B	27	CTAERR_OUTPUT_ACTIVE
0x0000001D	29	CTAERR_LOCK_TIMEOUT
0x00010001	65537	ADIERR_PLAYREC_ACCESS
0x00010002	65538	ADIERR_INVALID_QUEUEID
0x00010003	65539	ADIERR_UNKNOWN_BOARDTYPE
0x00010004	65540	ADIERR_TOO_MANY_BUFFERS
0x00010005	65541	ADIERR_INVALID_CALL_STATE
0x00010006	65542	ADIERR_CANNOT_CREATE_CHANNEL
0x00010007	65543	ADIERR_NO_DSP_PORT
0x00010008	65544	ADIERR_NO_DSP_RESOURCES
0x0001000a	65546	ADIERR_NOT_ENOUGH_RESOURCES

Version

Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com