ar_modify_msg_block

short ar_modify_msg_block (int numberOfEntries, AR_SCHEDULED_MSG_ENTRY_TYPE * messageEntry);

Purpose

This routine modifies a block of existing 32-bit ARINC 429 messages already created for periodic retransmission via ar_define_msg_block.

Parameters

Input

Name

Type

Description

numberOfEntries

int

(input) the number of entries to define or modify, used as a
reference for the number of structure elements defined via the messageEntry structure pointer.

Output

 

 

Name

Type

Description

messageEntry

AR_SCHEDULED_MSG_ENTRY_TYPE (passed by reference)

(input) An array of structures of message definition, each element defined as follows:

struct {                 
     unsigned int messageIndex;   
     unsigned int board;          
     unsigned int channel;        
     unsigned int rate;           
     unsigned int start;          
     unsigned int txCount;
     unsigned int data;
}


messageIndex
This unique message scheduler table entry index assigned to this message via ar_define_msg_block.

board
The device to access.  Valid range is 0-15.

channel
The transmit channel to reference.  The valid range is 0 to one less than the installed ARINC 429 transmit channel count.

rate
The periodic transmission rate, defined in milliseconds.

start
The start offset cannot be modified from its initial periodic transmission offset.

txCount
The total number of times this message will be transmitted (0xFFFFFFFF indicates infinite transmission of this message is desired).

data
The 32-bit ARINC message to transmit.

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_INVARG            Invalid numberOfEntries parameter value or channel structure member value.
ARS_INVHARVAL       Message scheduling not supported on the specified transmit channel.
ARS_BOARD_MUTEX Access to the Board Lock timed-out/failed.
ARS_FAILURE           The supplied message scheduler table index via messageIndex structure member exceeds the capacity of the table.

References

Transmit Data Processing Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description