ar_get_storage_mode

short ar_get_storage_mode (short board, short * mode);

Purpose

This function is provided for compatibility with legacy ARINC 429 device APIs.  It returns the current state of the API-managed global receive storage mode.  When this storage mode is buffered, each receiver is assigned an independent circular buffer for data storage (merged mode is disabled).  When this storage mode is merged, all receivers are set to enable merged receive mode and data received on each is stored in the merged FIFO buffer.  Each receive data API routine processes the active storage mode internally, acquiring data from the appropriate buffer.  Since each receive channel can be independently programmed to store data in buffered or merged mode via ar_set_device_config, this routine should only be used in conjunction with the ar_set_storage_mode routine.

Parameters

Input

Name

Type

Description

board

short

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

Output

 

 

Name

Type

Description

mode

short (passed by reference)

(output) Indicates the current state of the API-tracked Individual/Merged FIFO storage condition:
ARU_BUFFERED (0) device reception is using individual FIFOs
ARU_MERGED   (2) device reception is using the merged FIFO    

Return Value

Name

Type

Description

status

short

status of the function call, with valid values of:
ARS_NORMAL            Routine execution was successful.
ARS_INVBOARD        The board parameter value was invalid.

References

Device Configuration Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description