short ar_getblock (unsigned int board, unsigned int channel, int maxMessages, int offset, int * actualCount, int * data, int * timeTags);
This routine retrieves requested number of ARINC messages from the specified receive channel buffer and copies them to the desired destination, providing a 32-bit time-tag.
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. |
offset |
int |
Unused parameter, retained for legacy API support only. |
Output |
|
|
Name |
Type |
Description |
actualCount |
int (passed by reference) |
(output) The number of messages actually retrieved. |
data |
int (passed by reference) |
(input) Array to which all retrieved 32-bit ARINC 429 messages values will be copied. |
timeTags |
int (passed by reference) |
(input) If not NULL, the array to which all 32-bit time-tag values will be copied, (resolution is based on the current programmed timer reference). |
Name |
Type |
Description |
status |
short |
status
of the function call, with valid values of: ARS_INVARG The data or actualCount parameter reference was NULL, or an invalid maxMessages parameter value was provided. 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. |
Receive Data Processing Functions
Alphabetical
Function Index
Hierarchical
Function Index