(Page 1 of 1 in this chapter) Version

Appendix B

BRI Service Errors

Introduction

This appendix provides a summary of BRI service error codes.
The BRI 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 BRI 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.
BRI service error codes are defined in the include file bridef.h and ctaerr.h. The error codes are prefixed with BRIERR_ 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 BRI 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 BRI_function_DONE where function is the completed function (e.g., START_PROTOCOL).
An asynchronous function may return SUCCESS to the application when invoked and the function can later fail on the BX 2000 board. If a BX 2000 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 BRI service errors:

Error Name

Hex

Decimal

Description

BRIERR_INVALID_CALL_STATE

0x00160005

1441797

This function is not valid in the current call state.

CTAERR_ALREADY_INITIALIZED

0x00010003

65539

The BRI service has been initialized twice.

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.

CTAERR_CREATE_EVENT_FAILED

0x0000002a

42

The BRI service could not create some internal event objects.

CTAERR_DRIVER_ERROR

0X00000003

3

An unexpected error occurred on the BX 2000 board. In most cases, there will also be a BRIEVN_BOARD_ERROR event, which contains the board error.

CTAERR_DRIVER_OPEN_FAILED

0x00000014

20

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

CTAERR_DRIVER_SEND_FAILED

0x00000017

23

An error was returned by the BX driver when sending a message to the BX 2000 board.

CTAERR_FATAL

0x00000002

2

An internal error occurred in the CT Access library. Please contact NMS Developer Support.

CTAERR_INTERNAL_ERROR

0x0000002d

45

BRI service internal error.

CTAERR_INVALID_BOARD

0x0000001a

26

The specified BX 2000 board number has not been successfully configured.

CTAERR_INVALID_CTAHD

0x00000005

5

The context handle is invalid.

CTAERR_INVALID_HANDLE

0x00000020

32

The handle passed to the BRI service is invalid.

CTAERR_INVALID_SEQUENCE

0x00000013

19

An unexpected command appears in the CTA context's current state.

CTAERR_NOT_FOUND

0x0000000a

10

The specified parameter does not exist.

CTAERR_NOT_IMPLEMENTED

0x00000009

9

An unreferenced brixxx function has been called before the BRI service has been initialized or an unsupported function has been called.

CTAERR_OS_INTERNAL_ERROR

0x0000002c

44

An operating system-specific function used in the BRI service failed.

CTAERR_OUT_OF_MEMORY

0x00000006

6

Unable to allocate memory for driver or port context, for play or record buffers, or for temporary storage.

CTAERR_OUT_OF_RESOURCES

0x00000008

8

The BRI service could not allocate memory for internal purposes.

Error Name	Hex	Decimal	Description
`BRIERR_INVALID_CALL_STATE`	`0x00160005`	`1441797`	This function is not valid in the current call state.
`CTAERR_ALREADY_INITIALIZED`	`0x00010003`	`65539`	The BRI service has been initialized twice.
`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.
`CTAERR_CREATE_EVENT_FAILED`	`0x0000002a`	`42`	The BRI service could not create some internal event objects.
`CTAERR_DRIVER_ERROR`	`0X00000003`	`3`	An unexpected error occurred on the BX 2000 board. In most cases, there will also be a `BRIEVN_BOARD_ERROR` event, which contains the board error.
`CTAERR_DRIVER_OPEN_FAILED`	`0x00000014`	`20`	The BX 2000 driver open failed because either it was not installed or the maximum number of opens has been exceeded.
`CTAERR_DRIVER_SEND_FAILED`	`0x00000017`	`23`	An error was returned by the BX driver when sending a message to the BX 2000 board.
`CTAERR_FATAL`	`0x00000002`	`2`	An internal error occurred in the CT Access library. Please contact NMS Developer Support.
`CTAERR_INTERNAL_ERROR`	`0x0000002d`	`45`	BRI service internal error.
`CTAERR_INVALID_BOARD`	`0x0000001a`	`26`	The specified BX 2000 board number has not been successfully configured.
`CTAERR_INVALID_CTAHD`	`0x00000005`	`5`	The context handle is invalid.
`CTAERR_INVALID_HANDLE`	`0x00000020`	`32`	The handle passed to the BRI service is invalid.
`CTAERR_INVALID_SEQUENCE`	`0x00000013`	`19`	An unexpected command appears in the CTA context's current state.
`CTAERR_NOT_FOUND`	`0x0000000a`	`10`	The specified parameter does not exist.
`CTAERR_NOT_IMPLEMENTED`	`0x00000009`	`9`	An unreferenced brixxx function has been called before the BRI service has been initialized or an unsupported function has been called.
`CTAERR_OS_INTERNAL_ERROR`	`0x0000002c`	`44`	An operating system-specific function used in the BRI service failed.
`CTAERR_OUT_OF_MEMORY`	`0x00000006`	`6`	Unable to allocate memory for driver or port context, for play or record buffers, or for temporary storage.
`CTAERR_OUT_OF_RESOURCES`	`0x00000008`	`8`	The BRI service could not allocate memory for internal purposes.

Numerical Error Summary

The following table is a list of BRI 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 0x0000000a 10 CTAERR_NOT_FOUND 0x0000000b 11 CTAERR_BAD_SIZE 0x0000000c 12 CTAERR_INVALID_STATE 0x00000013 19 CTAERR_INVALID_SEQUENCE 0x00000014 20 CTAERR_DRIVER_OPEN_FAILED 0x00000017 23 CTAERR_DRIVER_SEND_FAILED 0x00000018 24 CTAERR_DRIVER_ERROR 0x0000001a 26 CTAERR_INVALID_BOARD 0x0000001e 30 CTAERR_ALREADY_INITIALIZED 0x0000001f 31 CTAERR_NOT_INITIALIZED 0x00000020 32 CTAERR_INVALID_HANDLE 0x0000002a 42 CTAERR_CREATE_EVENT_FAILED 0x0000002c 44 CTAERR_OS_INTERNAL_ERROR 0x0000002d 45 CTAERR_INTERNAL_ERROR 0x00160005 1441797 BRIERR_INVALID_CALL_STATE

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`
`0x0000000a`	`10`	`CTAERR_NOT_FOUND`
`0x0000000b`	`11`	`CTAERR_BAD_SIZE`
`0x0000000c`	`12`	`CTAERR_INVALID_STATE`
`0x00000013`	`19`	`CTAERR_INVALID_SEQUENCE`
`0x00000014`	`20`	`CTAERR_DRIVER_OPEN_FAILED`
`0x00000017`	`23`	`CTAERR_DRIVER_SEND_FAILED`
`0x00000018`	24	`CTAERR_DRIVER_ERROR`
`0x0000001a`	`26`	`CTAERR_INVALID_BOARD`
`0x0000001e`	`30`	`CTAERR_ALREADY_INITIALIZED`
`0x0000001f`	`31`	`CTAERR_NOT_INITIALIZED`
`0x00000020`	`32`	`CTAERR_INVALID_HANDLE`
`0x0000002a`	`42`	`CTAERR_CREATE_EVENT_FAILED`
`0x0000002c`	`44`	`CTAERR_OS_INTERNAL_ERROR`
`0x0000002d`	`45`	`CTAERR_INTERNAL_ERROR`
`0x00160005`	`1441797`	`BRIERR_INVALID_CALL_STATE`

(Page 1 of 1 in this chapter) Version

tech_support@nmss.com