ar_get_573_frame

short ar_get_573_frame (short board, unsigned int * numberWords, unsigned short * arincData);

Purpose

When the ARINC 573 receiver is configured for auto-sync, this function will attempt to read the specified number of words from the ARINC 573/717 receive buffer, (up to an entire ARINC 573 frame based on the specified sub-frame size from the channel speed/size selection).  If the receiver is configured for raw reception, all available data up to the size requested will be retrieved from the receive channel buffer.  If the receive buffer doesn't contain any data, it will return an indicator as such.

Parameters

Input

Name

Type

Description

board

short

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

Output

 

 

Name

Type

Description

numberWords

unsigned int (passed by reference)

(input)  The number of individual 12-bit ARINC 573/717 messages to retrieve.
(output) The number of messages actually read from the receive buffer.

arincData

unsigned short (passed by reference)

(output) Array allocated for the ARINC 573/717 frame data retrieved.

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       ARINC 573/717 reception is not available with this device configuration.

ARS_INVARG            The arincData parameter reference was NULL.

References

Receive Data Processing Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description