ar_get_label_filter

short ar_get_label_filter (short board, unsigned short label);

Purpose

This function returns the active state of label filtering for the specified label on each of the first sixteen installed receive channels.

Parameters

Input

Name

Type

Description

board

short

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

label

unsigned short

(input) Specifies which label to query, (valid range is 0 to 255).

Return Value

Name

Type

Description

status

short

Given the routine is supplied with a valid board and label value, the return value indicates the bit-wise active state of the specified label on each receive channel, where the label filter state on receive channel zero (zero-referenced) is indicated via b0 as “1” to indicate the label is filtered and “0” to indicate either the label is not filtered or the receive channel is not installed.  Subsequent bits in the value indicate the label filter state for the respective receive channel, for 16 possible receive channels.

A label is indicated to be “filtered” if the respective entry in the Label Filter Table is defined to filter the label from either the Sequential (FIFO) or Snapshot buffers

References

Device Configuration Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description