ar_get_data

short ar_get_data (short board, short * channel, unsigned int * data, unsigned int * timeTagLo, unsigned int * timeTagHi);

Purpose

This function retrieves the most stale unread ARINC 429 message and 64-bit time-tag from the specified receive channel.

Parameters

Input

Name

Type

Description

board

short

(input) Device Number of the board to reference, (valid range is 0-15).

Output

 

 

Name

Type

Description

channel

short (passed by reference)

(input) Specifies which receive channel this routine is to access.  Valid range is 0 to one less than the installed ARINC 429 receive channel count.
(output) If the merged receive mode was active for the specified channel, this parameter returns the receive channel number on which the data was actually received.

data

unsigned int (passed by reference)

(output) The received ARINC 429 message.

timeTagLo

unsigned int (passed by reference)

(output) The lower 32 bits of the 64-bit time-tag associated with the received data, (resolution of the combined time-tag words is 1 microsecond).

timeTagHi

unsigned int (passed by reference)

(output) The upper 32 bits of the 64-bit time-tag associated with the received data, (resolution of the combined time-tag words is 1 microsecond).

Return Value

Name

Type

Description

status

short

status of the function call, with valid values of:
ARS_GOTDATA          Success - data returned.
ARS_NODATA            No data was available.
ARS_INVBOARD        The board parameter value was invalid.
ARS_INVHARVAL       The channel parameter was not valid for this device configuration.

ARS_INVARG            The data parameter reference was NULL.

ARS_BOARD_MUTEX  Access to the Board Lock timed-out/failed.

ARS_BAD_MESSAGE  An invalid length ARINC 429 message was detected.

References

Receive Data Processing Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description