ar_get_error

char * ar_get_error (short error_num);

Purpose

Most of the functions in the CEI-x30 API return status values which may indicate an error condition.  Passing the return status value to this function will result in the assignment of a pointer to a message string describing the error.                                                  

Parameters

Input

Name

Type

Description

statusCode

short

(input) Any status value returned by one of the CEI-x30 API functions.  Status values supported by the CEI-x30 API are defined as:

C Constant

Value

Constant Definition

ARS_FAILURE

  -1

Requested operation failed

ARS_NODATA

   0

No data was detected or received

ARS_NORMAL

    1

Normal successful completion

ARS_GOTDATA

    4

Data was received

ARS_BAD_MESSAGE

    5

Receipt of an invalid ARINC 429 message was detected

ARS_INVHARVAL

1003

Invalid configuration value

ARS_XMITOVRFLO

1004

Transmit buffer overflow

ARS_INVBOARD

1005

Invalid board argument

ARS_NOSYNC

1006

Transmit buffer flush failed

ARS_MEMWRERR

1013

SRAM memory test error

ARS_INVARG

1019

General invalid argument value

ARS_DRIVERFAIL

1021

Driver failed to install or uninstall the ISR

ARS_WINRTFAIL

1022

Device driver open failure

ARS_CHAN_TIMEOUT

1023

Channel timeout in receive function

ARS_NO_HW_SUPRT

1024

Function not supported by specified hardware

ARS_HW_CONSISTENCY

1029

Device is not programmed for Enhanced Firmware operations

ARS_WRAP_DATA_FAIL

1031

BIT wrap test data read-back fail

ARS_WRAP_FLUSH_FAIL

1035

BIT cannot execute external wrap test due to unknown external data reception

ARS_WRAP_DROP_FAIL

1036

BIT wrap test data not received

ARS_INT_ISR

1037

Driver failed to install or uninstall API interrupt support

ARS_BOARD_MUTEX

1038

API routine failed to acquire or release a board lock mechanism

ARS_NO_OS_SUPPORT

1041

There is no operating system support for the requested feature

ARS_ERR_SH_MEM_OBJ

1050

API failed to allocate a shared object (semaphore or mutex)

ARS_ERR_SH_MEM_MAP

1051

API failed to allocate a shared memory region (multi-process)

Return Value

Name

Type

Description

messagePtr

char *

(output) Pointer to a string describing the supplied statusCode value, minimum length is 50 characters.

References

Utility Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description