MX Foundation 4

Functions

uint32 mxfA708TxAperiodicWrite (HMXF_BUFFER buffer, uint64 options, uint64 startTime, uint64 count, MXF_A708_DATAREC *rec)
 
uint32 mxfA708TxPeriodicUpdateMsgWrite (HMXF_BUFFER buffer, uint64 count, MXF_A708_DATAREC *rec)
 
uint32 mxfA708RxAcqMsgSelectGet (HMXF_BUFFER buffer, uint64 maxCount, uint64 *count, uint64 *labels)
 
uint32 mxfA708RxAcqMsgSelectSet (HMXF_BUFFER buffer, uint64 select, uint64 count, uint64 *labels)
 
uint32 mxfA708RxAcqRead (HMXF_BUFFER buffer, uint64 maxMsgCount, uint64 maxBytesCount, uint64 *status, uint64 *msgCount, uint64 *byteCount, MXF_A708_DATAREC *rec)
 
uint32 mxfA708RxSamplingMsgSelectSet (HMXF_BUFFER buffer, uint64 select, uint64 count, uint64 *labels)
 
uint32 mxfA708RxSamplingMsgSelectGet (HMXF_BUFFER buffer, uint64 maxCount, uint64 *count, uint64 *labels)
 
uint32 mxfA708RxSamplingRead (HMXF_BUFFER buffer, uint64 flags, uint64 maxMsgCount, uint64 maxBytesCount, uint64 *msgCount, uint64 *byteCount, MXF_A708_SAMPREC *rec)
 
uint32 mxfA708RxSamplingSingleRead (HMXF_BUFFER buffer, uint64 flags, uint64 label, uint64 si, MXF_A708_SAMPREC *rec)
 
uint32 mxfA708NextDataRecordPtrGet (MXF_A708_DATAREC *currentRec, MXF_A708_DATAREC **nextRec)
 
uint32 mxfA708NextSamplingRecordPtrGet (MXF_A708_SAMPREC *currentRec, MXF_A708_SAMPREC **nextRec)
 
uint32 mxfA708AsyncEventRxMsgSelectSet (HMXF_ASYNCEVENT asyncEvent, HMXF_CHANNEL channel, uint64 select, uint64 count, MXF_MSGID_A708 *msg)
 
uint32 mxfA708AsyncEventRxMsgSelectGet (HMXF_ASYNCEVENT asyncEvent, HMXF_CHANNEL channel, uint64 maxCount, uint64 *count, MXF_MSGID_A708 *msg)
 
uint32 mxfA708EmbeddedNVStorageFileMsgSelectSet (HMXF_CHANNEL channel, uint64 select, uint64 count, uint64 *labels)
 
uint32 mxfA708EmbeddedNVStorageFileMsgSelectGet (HMXF_CHANNEL channel, uint64 maxCount, uint64 *count, uint64 *labels)
 
uint32 mxfA708EmbeddedNVStorageFileMsgRead (HMXF_NVSTORAGE nvStorage, uint64 fileIndex, uint64 maxMsgCount, uint64 maxBytesCount, uint64 *msgCount, uint64 *byteCount, MXF_A708_DATAREC *msg)
 
uint32 mxfA708EmbeddedNVStorageFileMsgWrite (HMXF_NVSTORAGE nvStorage, uint64 fileIndex, uint64 maxMsgCount, MXF_A708_DATAREC *msg, uint64 *count)
 

Detailed Description

Function Documentation

uint32 mxfA708TxAperiodicWrite ( HMXF_BUFFER  buffer,
uint64  options,
uint64  startTime,
uint64  count,
MXF_A708_DATAREC rec 
)
C#
public static extern UInt32 mxfA708TxAperiodicWrite(UInt64 buffer, UInt64 options, UInt64 startTime, UInt64 count, IntPtr rec);

Sends aperiodic data record for transmission. The data items to be transmitted are specified within the records, along with an optional time tag. The first data item is transmitted at the specified starting time.

The records to transmit on time tag must be placed in chronological order in the array. The same time tag must not appear more than once in the array. When the start time is specified the time tag of the first record or the start time should be at least 50 msec in advance to be relatively precise, otherwise it will be sent as soon as possible. Also, the cumulative time of all record’s time tag and the start time must be smaller than 30 seconds.

Note
This function is the specific version for A708 of the multi-protocol mxfTxAperiodicWrite() function.
Parameters
[in]bufferbuffer handle.
[in]optionsoptions for controlling the transmitter before for sending the data records. The details of the options are explained below.
  • MXF_TXAPERIODIC_FLAG_DEFAULT
  • MXF_TXAPERIODIC_FLAG_USE_RECORD_ABSOLUTE_TIME
  • MXF_TXAPERIODIC_FLAG_ABSOLUTE_START_TIME
  • MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME

[in]startTimestart time based on the timebase. This is the time at which the data held in the first record is transmitted by the device. The time is either expressed accordingly to the process time base or relative to the current real-time clock value (i.e. offset in the future). If the bit MXF_TXAPERIODIC_FLAG_ABSOLUTE_START_TIME of the transmit flag is set, then the start time is specified in absolute time (rather than relative). MXF_TXAPERIODIC_FLAG_USE_RECORD_ABSOLUTE_TIME or MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME options can't be used with a start time.
[in]countnumber of records to write.
[in]recpointer to MXF_A708_DATAREC records to write. The records in the buffer need to be indexed using mxfA708NextDataRecordPtrGet() function.


The options modify the transmission scheme as described below:

  • MXF_TXAPERIODIC_FLAG_DEFAULT

    This is the default transmission flag, the scheduling priority defined when the buffer area was defined (see mxfTxAperiodicBufferAlloc()) is used to schedule the transmissions.

    The time tag field is not used and must be set to 0. The records are transmitted with minimum delay between them.

  • MXF_TXAPERIODIC_FLAG_USE_RECORD_ABSOLUTE_TIME

    When set, the absolute transmit time of each data must be set in the record time tag. The time tag must be formatted according to the process time base.

    This flag can’t be used with MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME, MXF_TXAPERIODIC_FLAG_ABSOLUTE_START_TIME or a start time.

  • MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME

    When set, the relative transmit time of each data must be set in the record time tag. The process time base resolution is used, but the time base itself is ignored.

    This option causes transmission of the first record at the specified offset and transmission of the remaining records after a delay that is computed by subtracting the record time tag from the time tag of preceding records (i.e. delta time).

    Let’s assume N data records to be transmitted with the MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME.

    The actual record data transmit time will be computed as follows:

    Time rec1 = Transmission offset (min 50 msec)
    Time rec2 = Time rec1 + (rec2 time tag – rec1 time tag )
    Time rec3 = Time rec2 + (rec3 time tag – rec2 time tag )

    Time recN = Time recN-1 + (recN time tag - recN-1 time tag )

    This flag can’t be used with MXF_TXAPERIODIC_FLAG_USE_RECORD_ABSOLUTE_TIME, MXF_TXAPERIODIC_FLAG_ABSOLUTE_START_TIME or a start time.

  • MXF_TXAPERIODIC_FLAG_ABSOLUTE_START_TIME

    When set, the startTime parameter must be formatted according to the process time base.

    If not set, the startTime parameter is expressed as a relative time from the current real time clock value. The process time base resolution is used, but the time base itself is ignored.

    The time tag field is not used and must be set to 0. The first record is sent at the specified start time and then the other records are transmitted with minimum delay between them.

    This flag cannot be used with MXF_TXAPERIODIC_FLAG_USE_RECORD_ABSOLUTE_TIME or MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME options.
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfTxAperiodicWrite()
mxfTxAperiodicBufferAlloc()
mxfTxAperiodicBufferStatusGet()
mxfTxAperiodicClear()
mxfSystemTimeBaseSet()
mxfA708NextDataRecordPtrGet()
Examples:
ar708.c, ar708.cs, ar708_aperiodic.c, ar708_aperiodic.cs, ar708_event_handler.c, ar708_event_handler.cs, ar708_trigger.c, and ar708_trigger.cs.
uint32 mxfA708TxPeriodicUpdateMsgWrite ( HMXF_BUFFER  buffer,
uint64  count,
MXF_A708_DATAREC rec 
)
C#
public static extern UInt32 mxfA708TxPeriodicUpdateMsgWrite(UInt64 buffer, UInt64 count, IntPtr rec);

Writes messages of the record array into the specified buffer. The last message of each buffer is sent forever until a new message is written into the buffer.

Note
This function is the specific version for ARINC 708 of the multi-protocol mxfTxPeriodicUpdateMsgWrite() function.
Parameters
[in]bufferbuffer handle.
[in]countcount of records to write.
[in]recarray of record(s) to write. The records in the buffer need to be indexed using mxfA708NextDataRecordPtrGet() function.
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfTxPeriodicUpdateMsgWrite()
mxfTxPeriodicUpdateMsgBufferStatusGet()
mxfTxPeriodicUpdateMsgClear()
mxfA708NextDataRecordPtrGet()
Examples:
ar708_buffer_threshold.c, ar708_buffer_threshold.cs, ar708_periodic.c, ar708_periodic.cs, ar708_sampling.c, ar708_sampling.cs, ar708_tx_error_injection.c, and ar708_tx_error_injection.cs.
uint32 mxfA708RxAcqMsgSelectGet ( HMXF_BUFFER  buffer,
uint64  maxCount,
uint64 *  count,
uint64 *  labels 
)
C#
public static extern UInt32 mxfA708RxAcqMsgSelectGet(UInt64 buffer, UInt64 maxCount, out UInt64 count, [Out] UInt64[] labels);

Returns the list of labels selected for acquisition.

Note
This function is the specific version for ARINC 708 of the multi-protocol mxfRxAcqMsgSelectGet() function.
Parameters
[in]bufferbuffer handle.
[in]maxCountmaximum number of labels in the array.
[out]countreturned number of labels in the label array.
[out]labelsaddress of the returned label array.
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfRxAcqMsgSelectGet()
mxfRxAcqBufferAlloc()
mxfRxAcqBufferGet()
mxfA708RxAcqMsgSelectSet()
uint32 mxfA708RxAcqMsgSelectSet ( HMXF_BUFFER  buffer,
uint64  select,
uint64  count,
uint64 *  labels 
)
C#
public static extern UInt32 mxfA708RxAcqMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 count, UInt64[] labels);

>public static extern UInt32 mxfA708RxAcqMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 count, IntPtr labels);

Selects or deselects the label(s) to be acquired on the specified acquisition buffer.

Upon data arrival, the embedded process will check if the received label is found in the current selection list. The receive data record will be added to the acquisition buffer only if the label is found in the selection list, otherwise it is discarded.

By default, after a device reset, no filtering is performed and all labels are received.

Note
count set to 0 with labels set to NULL means ALL labels.
This function is the specific version for ARINC 708 of the multi-protocol mxfRxAcqMsgSelectSet() function.
Parameters
[in]bufferbuffer handle.
[in]selectaction to perform with the message ID array.
Option Description
MXF_MSG_DESELECT Deselects the label(s).
MXF_MSG_SELECT_ADD Adds the specified label(s).
MXF_MSG_SELECT_ONLY Replaces the current selection with the provided list.
[in]countnumber of entries in labels.
[in]labelsaddress of array of labels
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfRxAcqMsgSelectSet()
mxfRxAcqBufferAlloc()
mxfRxAcqBufferGet()
mxfA708RxAcqMsgSelectGet()
uint32 mxfA708RxAcqRead ( HMXF_BUFFER  buffer,
uint64  maxMsgCount,
uint64  maxBytesCount,
uint64 *  status,
uint64 *  msgCount,
uint64 *  byteCount,
MXF_A708_DATAREC rec 
)
C#
public static extern UInt32 mxfA708RxAcqRead(UInt64 buffer, UInt64 maxRecCount, UInt64 maxBytesCount, out UInt64 status, out UInt64 recCount, out UInt64 bytesCount, IntPtr rec);

Transfers the records from the channel acquisition buffer to the calling application.

Note
This function is the specific version for A708 of the multi-protocol mxfRxAcqRead() function.
Parameters
[in]bufferbuffer handle.
[in]maxMsgCountmaximum messages to read (0 means all messages).
[in]maxBytesCountmaximum number of bytes to be read.
[out]statuslast status set.
[out]msgCountnumber of records returned.
[out]byteCountnumber of bytes returned.
[out]recaddress of data records. The records in the buffer need to be indexed using mxfA708NextDataRecordPtrGet() function.
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfRxAcqRead()
mxfRxAcqStart()
mxfRxAcqBufferAlloc()
mxfRxAcqStop()
mxfA708NextDataRecordPtrGet()
Examples:
ar708.c, ar708.cs, ar708_aperiodic.c, ar708_aperiodic.cs, ar708_buffer_threshold.c, ar708_periodic.c, ar708_periodic.cs, ar708_trigger.c, and ar708_trigger.cs.
uint32 mxfA708RxSamplingMsgSelectSet ( HMXF_BUFFER  buffer,
uint64  select,
uint64  count,
uint64 *  labels 
)
C#
public static extern UInt32 mxfA708RxSamplingMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 count, UInt64[] labels);

public static extern UInt32 mxfA708RxSamplingMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 count, IntPtr labels);

Selects or deselects the label(s) to be received on the specified sampling buffer.

Upon data arrival, the embedded process check if the received label is defined in the current selection list. The receive data record will be added to the sampling buffer only if the label was added previously in the selection list, otherwise it is discarded.

By default, after a device reset, no filtering is performed and all labels are received.

Note
count set to 0 with labels set to NULL means ALL labels.
This function is the specific version for ARINC 708 of the multi-protocol mxfRxSamplingMsgSelectSet() function.
Parameters
[in]bufferbuffer handle.
[in]selectaction to perform with the message ID array.
Option Description
MXF_MSG_DESELECT Deselects the label(s).
MXF_MSG_SELECT_ADD Adds the specified label(s).
MXF_MSG_SELECT_ONLY Replaces the current selection with the provided list.
[in]countcount of labels in the array.
[in]labelsaddress of array of label(s).
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfRxSamplingMsgSelectSet()
mxfRxSamplingBufferAlloc()
mxfRxSamplingStart()
mxfA708RxSamplingRead()
mxfA708RxSamplingMsgSelectGet()
uint32 mxfA708RxSamplingMsgSelectGet ( HMXF_BUFFER  buffer,
uint64  maxCount,
uint64 *  count,
uint64 *  labels 
)
C#
public static extern UInt32 mxfA708RxSamplingMsgSelectGet(UInt64 buffer, UInt64 maxCount, out UInt64 count, [Out] UInt64[] labels);

Returns the list of labels selected for sampling.

Note
This function is the specific version for ARINC 708 of the multi-protocol mxfRxSamplingMsgSelectGet() function.
Parameters
[in]bufferbuffer handle.
[in]maxCountmaximum number of labels in the array labels.
[out]countreturned number of labels in the labels array.
[out]labelsaddress of the returned labels array.
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfRxSamplingMsgSelectGet()
mxfRxSamplingBufferAlloc()
mxfRxSamplingStart()
mxfA708RxSamplingRead()
mxfA708RxSamplingMsgSelectSet()
uint32 mxfA708RxSamplingRead ( HMXF_BUFFER  buffer,
uint64  flags,
uint64  maxMsgCount,
uint64  maxBytesCount,
uint64 *  msgCount,
uint64 *  byteCount,
MXF_A708_SAMPREC rec 
)
C#
public static extern UInt32 mxfA708RxSamplingRead(UInt64 buffer, UInt64 flags, UInt64 maxRecCount, UInt64 maxBytesCount, out UInt64 recCount, out UInt64 bytesCount, IntPtr rec);

Reads all sampling records from the sampling buffer to the application buffer.

The sampling process maintains records for all of the received labels. A label is considered received if corresponding data words were received within the kill-time period. A record refresh from the receive port resets the kill-time timer and an updated copy is made available to the application.

The sampling record contains information on the arrival rate and the number of errors, as well as the latest data received for that label.

Note
This function is the specific version for ARINC 708 of the multi-protocol mxfRxSamplingRead() function.
Parameters
[in]bufferbuffer handle.
[in]flagsoption flag.
Flags Description
MXF_RXSAMPLING_FLAG_DEFAULT The record is kept in the buffer and the same record can be read again by the current or another application.
MXF_RXSAMPLING_FLAG_ERASE_WHEN_READ After the sampling record is returned, it is removed from the buffer.
[in]maxMsgCountmaximum number of messages to read (0 means all messages).
[in]maxBytesCountmaximum number of bytes to read.
[out]msgCountnumber of messages returned.
[out]byteCountnumber of bytes returned.
[out]recarray of sampling record structure. The records in the buffer need to be indexed using mxfA708NextSamplingRecordPtrGet().
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfRxSamplingRead()
mxfRxSamplingBufferAlloc()
mxfA708RxSamplingMsgSelectSet()
mxfRxSamplingStart()
mxfA708NextSamplingRecordPtrGet()
Examples:
ar708_sampling.c, ar708_sampling.cs, ar708_tx_error_injection.c, and ar708_tx_error_injection.cs.
uint32 mxfA708RxSamplingSingleRead ( HMXF_BUFFER  buffer,
uint64  flags,
uint64  label,
uint64  si,
MXF_A708_SAMPREC rec 
)
C#
public static extern UInt32 mxfA708RxSamplingSingleRead(UInt64 buffer, UInt64 flags, UInt64 label, IntPtr rec);

Reads a specific sampling record from the sampling buffer.

Note
This function is the specific version for ARINC 708 of the multi-protocol mxfRxSamplingSingleRead() function.
Parameters
[in]bufferbuffer handle.
[in]flagsoption flag.
Flags Description
MXF_RXSAMPLING_FLAG_DEFAULT The record is kept in the buffer and the same record can be read again by the current or another application.
MXF_RXSAMPLING_FLAG_ERASE_WHEN_READ After the sampling record is returned, it is removed from the buffer.
[in]labelmessage label.
[in]simessage si.
[out]recaddress of sampling record.
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfRxSamplingSingleRead()
mxfRxSamplingBufferAlloc()
mxfRxSamplingMsgSelectSet()
mxfRxSamplingStart()
mxfRxSamplingStop()
uint32 mxfA708NextDataRecordPtrGet ( MXF_A708_DATAREC currentRec,
MXF_A708_DATAREC **  nextRec 
)
C#
public static extern UInt32 mxfA708NextDataRecordPtrGet(IntPtr currentRec, out IntPtr nextRec);

Returns the next buffer address in a MXF_A708_DATAREC buffer array.

Note
This function is the specific version for A708 of the multi-protocol mxfNextRecordPtrGet() function.
Parameters
[in]currentRecpointer to the beginning or the current record in the buffer.
[out]nextRecpointer to next record in the buffer.
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfNextRecordPtrGet()
mxfA708RxAcqRead()
mxfA708TxAperiodicWrite()
Examples:
ar708.c, ar708.cs, ar708_aperiodic.c, ar708_aperiodic.cs, ar708_buffer_threshold.c, ar708_buffer_threshold.cs, ar708_event_handler.c, ar708_event_handler.cs, ar708_periodic.c, ar708_periodic.cs, ar708_sampling.c, ar708_sampling.cs, ar708_trigger.c, ar708_trigger.cs, ar708_tx_error_injection.c, and ar708_tx_error_injection.cs.
uint32 mxfA708NextSamplingRecordPtrGet ( MXF_A708_SAMPREC currentRec,
MXF_A708_SAMPREC **  nextRec 
)
C#
public static extern UInt32 mxfA708NextSamplingRecordPtrGet(IntPtr currentRec, out IntPtr nextRec);

Returns the next buffer address in a MXF_A708_SAMPREC buffer array.

Note
This function is the specific version for ARINC 708 of the multi-protocol mxfNextRecordPtrGet() function.
Parameters
[in]currentRecpointer to the beginning or the current record in the buffer.
[out]nextRecpointer to next record in the buffer.
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfNextRecordPtrGet()
mxfA708RxSamplingRead()
mxfA708NextDataRecordPtrGet()
Examples:
ar708_sampling.c, and ar708_tx_error_injection.c.
uint32 mxfA708AsyncEventRxMsgSelectSet ( HMXF_ASYNCEVENT  asyncEvent,
HMXF_CHANNEL  channel,
uint64  select,
uint64  count,
MXF_MSGID_A708 msg 
)
C#
public static extern UInt32 mxfA708AsyncEventRxMsgSelectSet(UInt64 asyncEvent, UInt64 channel, UInt64 select, UInt64 count, MXF_MSGID_A708[] msg);

public static extern UInt32 mxfA708AsyncEventRxMsgSelectSet(UInt64 asyncEvent, UInt64 channel, UInt64 select, UInt64 count, IntPtr msg);

Selects or deselects the label (message id) for MXF_ASYNCEVENT_COND_RX_MSG condition on a specified RX channel.

The function must be called in addition to the mxfAsyncEventConditionsSet() function with MXF_ASYNCEVENT_COND_RX_MSG condition to cause an asynchronous event to occur when a specific label-si is received.

The message selection must be made by only one asynchronous event routine for a specific channel. Otherwise, an error code will be returned while conditions of other asynchronous event routines are present.

In this case, you must disable the MXF_ASYNCEVENT_COND_RX_MSG condition using mxfAsyncEventConditionsSet() function using another asynchronous event handle.

Note
count set to 0 with msg set to NULL means ALL labels.
This function is the specific version for ARINC 708 of the multi-protocol mxfAsyncEventRxMsgSelectSet() function.
Parameters
[in]asyncEventasynchronous event handle.
[in]channelchannel handle.
[in]selectaction to perform for the message ID.
Action Description
MXF_MSG_DESELECT Deselects the messages id.
MXF_MSG_SELECT_ADD Adds the specified messages id.
MXF_MSG_SELECT_ONLY Replaces the current selection with the provided list.
[in]countcount of messages id.
[in]msgaddress of array of message id.
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfAsyncEventRxMsgSelectSet()
mxfAsyncEventHandlerInit()
mxfA708AsyncEventRxMsgSelectGet()
mxfAsyncEventConditionsSet()
uint32 mxfA708AsyncEventRxMsgSelectGet ( HMXF_ASYNCEVENT  asyncEvent,
HMXF_CHANNEL  channel,
uint64  maxCount,
uint64 *  count,
MXF_MSGID_A708 msg 
)
C#
public static extern UInt32 mxfA708AsyncEventRxMsgSelectGet(UInt64 asyncEvent, UInt64 channel, UInt64 maxCount, out UInt64 count, [Out] MXF_MSGID_A708[] msg);

Returns the list of message IDs registered for a specified RX channel for the MXF_ASYNCEVENT_COND_RX_MSG asynchronous event condition ID.

Note
This function is the specific version for ARINC 708 of the multi-protocol mxfAsyncEventRxMsgSelectGet() function.
Parameters
[in]asyncEventasynchronous event handle.
[in]channelchannel handle.
[in]maxCountmaximum ID messages expected.
[out]countnumber of ID messages returned.
[out]msgreturned message ID array.
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfAsyncEventRxMsgSelectGet()
mxfAsyncEventHandlerInit()
mxfA708AsyncEventRxMsgSelectSet()
mxfAsyncEventConditionsSet()
uint32 mxfA708EmbeddedNVStorageFileMsgSelectSet ( HMXF_CHANNEL  channel,
uint64  select,
uint64  count,
uint64 *  labels 
)
C#
public static extern UInt32 mxfA708EmbeddedNVStorageFileMsgSelectSet(UInt64 channel, UInt64 select, UInt64 count, UInt64[] labels);

public static extern UInt32 mxfA708EmbeddedNVStorageFileMsgSelectSet(UInt64 channel, UInt64 select, UInt64 count, IntPtr labels);

Selects / deselects the specified message IDs on a channel for automatic embedded non-volatile storage recording.

Note
This function should be called before the function mxfEmbeddedNVStorageFileMsgSelectEnableSet() that starts the logging of messages on file for the specific channel.
count set to 0 with a msg set to NULL means ALL labels.
This function is the specific version for A708 of the multi-protocol mxfEmbeddedNVStorageFileMsgSelectSet() function.
Parameters
[in]channelchannel handle
[in]selectaction to perform with the provided selection list
Action Description
MXF_MSG_DESELECT Deselects the messages
MXF_MSG_SELECT_ADD Adds the specified messages
MXF_MSG_SELECT_ONLY Replaces the current selection with the provided list
[in]countcount of messages
[in]labelspointer to an array of labels.
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfModuleChannelAllGet()
mxfEmbeddedNVStorageHandleGet()
mxfEmbeddedNVStorageFileMsgSelectEnableSet()
mxfEmbeddedNVStorageFileMsgSelectGet()
uint32 mxfA708EmbeddedNVStorageFileMsgSelectGet ( HMXF_CHANNEL  channel,
uint64  maxCount,
uint64 *  count,
uint64 *  labels 
)
C#
public static extern UInt32 mxfA708EmbeddedNVStorageFileMsgSelectGet(UInt64 channel, UInt64 maxCount, out UInt64 count, [Out] UInt64[] labels);

Returns the specific labels registered on a channel for automatic embedded non-volatile storage recording.

Note
This function is the specific version for A708 of the multi-protocol mxfEmbeddedNVStorageFileMsgSelectGet() function.
Parameters
[in]channelchannel handle.
[in]maxCountmaximum count of messages return in the array
[out]countcount of messages returned
[out]labelspointer to an array of labels.
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfModuleChannelAllGet()
mxfEmbeddedNVStorageHandleGet()
mxfEmbeddedNVStorageFileMsgSelectSet()
mxfEmbeddedNVStorageFileMsgSelectEnableSet()
uint32 mxfA708EmbeddedNVStorageFileMsgRead ( HMXF_NVSTORAGE  nvStorage,
uint64  fileIndex,
uint64  maxMsgCount,
uint64  maxBytesCount,
uint64 *  msgCount,
uint64 *  byteCount,
MXF_A708_DATAREC msg 
)
C#
public static extern UInt32 mxfA708EmbeddedNVStorageFileMsgRead(UInt64 storage, UInt64 fileIndex, UInt64 maxRecCount, UInt64 maxBytesCount, out UInt64 recCount, out UInt64 bytesCount, IntPtr rec);

Reads the records from a specific file. The messages format must be of type MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A708.

Note
This function is the specific version for A708 of the multi-protocol mxfEmbeddedNVStorageFileMsgRead() function.
Parameters
[in]nvStoragenon-volatile storage handle
[in]fileIndexfile index
[in]maxMsgCountmaximum number of messages that can be returned
[in]maxBytesCountmaximum byte count that can be returned
[out]msgCountcount of messages returned
[out]byteCountnumber of bytes returned in the msg buffer
[out]msgpointer to read buffer containing messages. The records in the buffer need to be indexed using the mxfA708NextDataRecordPtrGet() function.
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfEmbeddedNVStorageHandleGet()
mxfEmbeddedNVStorageFileStatusGet()
uint32 mxfA708EmbeddedNVStorageFileMsgWrite ( HMXF_NVSTORAGE  nvStorage,
uint64  fileIndex,
uint64  maxMsgCount,
MXF_A708_DATAREC msg,
uint64 *  count 
)
C#
public static extern UInt32 mxfA708EmbeddedNVStorageFileMsgWrite(UInt64 storage, UInt64 fileIndex, UInt64 maxRecCount, IntPtr rec, out UInt64 count);

Writes messages to the specified file. The messages format must be of type MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A708.

Note
This function is the specific version for A708 of the multi-protocol mxfEmbeddedNVStorageFileMsgWrite() function.
Parameters
[in]nvStoragenon-volatile storage handle
[in]fileIndexfile index
[in]maxMsgCountmaximum number of messages to write
[in]msgpointer to messages to write. The records in the buffer need to be indexed using mxfA708NextDataRecordPtrGet() function.
[out]countnumber of messages actually written
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfEmbeddedNVStorageHandleGet()
mxfEmbeddedNVStorageFileStatusGet()
Updated 03/30/2022