ar_channel_configuration_from_xml_file

short ar_channel_configuration_from_xml_file (char * pcCfgFileName,short cint16BrdIdx);

Purpose

This function assigns the state of the following channel configuration attributes from the application supplied XML-based channel configuration file generated via the AutoConfig ARINC utility:

·          Buffer Enable

·          Bit Rate

·          Parity Check/Generation

·          Receive Buffering Mode

·          Receive Internal Wrap

·          Transmit Protocol Error Injection

See the AutoConfig ARINC User’s Manual for a description of the acceptable Channel Configuration XML file format.

Parameters

Input

 

Name

Type

Description

pcCfgFileName

char *

(input) The complete path and file name defining the channel configuration file to be referenced by this routine.  A valid file name suffix can only be “.xml” for a channel configuration XML file.

cint16BrdIdx

short

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

Return Value

Name

Type

Description

status

short

status of the function call, with valid values of:
ARS_NORMAL            Success.
ARS_INVBOARD        Invalid or uninitialized board.
ARS_BADLOAD          Failed to open the specified channel configuration XML file.
ARS_INVHARVAL       An invalid channel value was detected in the XML file.
ARS_INVHARCMD      An invalid channel attribute was detected in the XML file.

ARS_BOARD_MUTEX  Access to the Board Lock timed-out/failed.
ARS_FAILURE            An invalid channel configuration XML format was detected.

References

Device Configuration Functions

Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description