ar_define_messages_from_xml_file

short ar_define_messages_from_xml_file (char * pcSMFileName);

Purpose

This function defines a series of ARINC 429 messages for periodic retransmission at the specified rate from the supplied XML scheduled message definition file generated via the AutoConfig ARINC utility.  See the AutoConfig ARINC User’s Manual for a description of the acceptable Scheduled Message Definition XML file format.

Parameters

Input

 

Name

Type

Description

cfgFileName

char *

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

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 was specified in the XML file.
ARS_BADLOAD          Failed to open the specified Scheduled Message Definition XML file.
ARS_INVHARCMD      An invalid message scheduler attribute entry was detected in the XML file.

ARS_BOARD_MUTEX  Access to the Board Lock timed-out/failed.
ARS_FAILURE            The number of entries requested exceeds the available number of entries in the referenced board’s message scheduler table.

References

Transmit Data Processing Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description