ar_getblock_t

short ar_getblock_t (unsigned int board, unsigned int channel, int maxMessages, int * actualCount, unsigned int * msgChan, int * data, int * timeTagMsw, int * timeTagLsw);

Purpose

This routine retrieves the requested number of ARINC messages from the specified receive channel buffer and copies them to the desired destination, providing a 64-bit time-tag.

Parameters

Input

Name

Type

Description

board

unsigned int

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

channel

unsigned int

(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.

maxMessages

int

(input) The number of messages to retrieve from the receive buffer.

Output

 

 

Name

Type

Description

actualCount

int (passed by reference)

(output) The number of messages actually retrieved.

msgChan

unsigned int (passed by reference)

(output) The receive channel number associated with each message provided in the data array, returned when the device is operating in the merged receive mode.

data

int (passed by reference)

(input) Array to which all retrieved 32-bit ARINC 429 messages values will be copied.

timeTagMsw

int (passed by reference)

(input) Array to which all 32-bit MSW of the associated 64-bit 1 microsecond time-tag values will be copied, if both timeTagMsw and timeTagLsw are not NULL.

timeTagLsw

int (passed by reference)

(input) Array to which all 32-bit LSW of the associated 64-bit 1 microsecond time-tag values will be copied, if both timeTagMsw and timeTagLsw are not NULL.

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 during retrieval of the message block.

References

Receive Data Processing Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description