ar_label_filter

short ar_label_filter (short board, short channel, unsigned short label, short action);

Purpose

This legacy function provides the method to enable and disable ARINC 429 label filtering for a specific channel/label combination.  If enabled, no messages having the specified label will be stored in the respective channel FIFO or SNAPSHOT buffers.  The requested action will apply to all messages having the specified label value, regardless of the SDI and ESSM field values contained therein.

Parameters

Input

Name

Type

Description

board

short

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

channel

short

(input) ARINC 429 channel number (valid range is 0 to one less than the installed ARINC 429 receive channel count)

label

unsigned short

(input) Label of interest.  Valid range is 0-255.  Also valid is ARU_ALL_LABELS (511), for which the API applies the "action" parameter selection to all valid labels.

action

short

(input) Enable or disable label filtering for the specified board/channel/label combination.  Valid action parameter values are:
ARU_FILTER_OFF (0)  disables label filtering
ARU_FILTER_ON  (1)  enables label filtering

Return Value

Name

Type

Description

status

short

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

ARS_BOARD_MUTEX   Access to the Board Lock timed-out/failed.
ARS_INVHARVAL        Invalid channel parameter value.

ARS_INVARG             Invalid label or action parameter value.

References

Device Configuration Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description