MX Foundation 4

Functions

uint32 mxfTxPeriodicUpdateMsgBufferAlloc (HMXF_CHANNEL channel, uint64 bufferIndex, uint64 size, HMXF_BUFFER *buffer, uint64 *allocated)
 
uint32 mxfTxPeriodicUpdateMsgBufferGet (HMXF_CHANNEL channel, uint64 bufferIndex, HMXF_BUFFER *buffer)
 
uint32 mxfTxPeriodicUpdateMsgBufferFree (HMXF_BUFFER buffer)
 
uint32 mxfTxPeriodicUpdateMsgBufferStatusGet (HMXF_BUFFER buffer, uint64 *msgCount, uint64 *pendingBytes, uint64 *freeBytes)
 
uint32 mxfTxPeriodicUpdateMsgBufferInfoGet (HMXF_BUFFER buffer, HMXF_CHANNEL *channel, uint64 *bufferIndex)
 
uint32 mxfTxPeriodicUpdateMsgWrite (HMXF_BUFFER buffer, uint64 count, void *rec)
 
uint32 mxfTxPeriodicUpdateMsgWriteAsync (HMXF_BUFFER buffer, uint64 count, void *hostBuffer, MXF_ASYNCHRONOUS_CALLBACK writeCompletion, void *context)
 
uint32 mxfTxPeriodicUpdateMsgUpdate (uint64 options, uint64 count, MXF_MSG_UPDATE_DATAREC rec[])
 
uint32 mxfTxPeriodicUpdateMsgClear (HMXF_BUFFER buffer, uint64 options)
 
uint32 mxfTxPeriodicUpdateMsgChannelAsyncEventInit (HMXF_CHANNEL channel, uint64 almostEmpty, void *context, MXF_ASYNCEVENT_BUFFER_HANDLER callback)
 
uint32 mxfTxPeriodicUpdateMsgChannelAsyncEventTerminate (HMXF_CHANNEL channel)
 
uint32 mxfTxPeriodicUpdateMsgChannelAsyncEventSelectSet (HMXF_CHANNEL channel, uint64 select, uint64 count, HMXF_BUFFER *bufferArray)
 
uint32 mxfTxPeriodicUpdateMsgChannelAsyncEventSelectGet (HMXF_CHANNEL channel, uint64 maxCount, uint64 *count, HMXF_BUFFER *bufferArray)
 
uint32 mxfTxErrChannelAsyncEventInit (HMXF_CHANNEL channel, void *context, MXF_ASYNCEVENT_TXERR_HANDLER callback)
 
uint32 mxfTxErrChannelAsyncEventTerminate (HMXF_CHANNEL channel)
 

Detailed Description

Function Documentation

uint32 mxfTxPeriodicUpdateMsgBufferAlloc ( HMXF_CHANNEL  channel,
uint64  bufferIndex,
uint64  size,
HMXF_BUFFER *  buffer,
uint64 *  allocated 
)
C#
public static extern UInt32 mxfTxPeriodicUpdateMsgBufferAlloc(UInt64 channel, UInt64 bufferIndex, UInt64 size, out UInt64 buffer, out UInt64 allocated);

public static extern UInt32 mxfTxPeriodicUpdateMsgBufferAlloc(UInt64 channel, UInt64 bufferIndex, UInt64 size, out UInt64 buffer, IntPtr allocated);

Allocates a periodic update transmission message buffer area to an application. The allocated size can be greater than the asked size (rounding is done for internal buffer alignment). allocated parameter can return the actual allocated size.

Parameters
[in]channelchannel handle.
[in]bufferIndexindex of the buffer to allocate
[in]sizesize of the transmit buffer in bytes to allocate.
[out]bufferhandle of periodic update buffer.
[out]allocatedreturned allocated size. Optional, pass NULL to if not needed.
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
mxfTxPeriodicUpdateMsgBufferFree()
mxfTxPeriodicUpdateMsgBufferGet()
mxfTxPeriodicUpdateMsgBufferStatusGet()
Examples:
ar429_buffer_threshold.c, ar429_buffer_threshold.cs, ar429_embedded_comm_queues.c, ar429_embedded_recorder.c, ar429_embedded_recorder.cs, ar429_periodic.c, ar429_periodic.cs, ar429_rx_acquisition_trigger.c, ar429_rx_acquisition_trigger.cs, ar429_rx_event_handler.c, ar429_rx_event_handler.cs, ar429_rx_sampling.c, ar429_rx_sampling.cs, ar629_alternate.c, ar629_alternate.cs, ar629_aperiodic_frame.c, ar629_aperiodic_frame.cs, ar629_block_mode.c, ar629_block_mode.cs, ar629_dual_xpp.c, ar629_dual_xpp.cs, ar629_error_injection_detection.c, ar629_error_injection_detection.cs, ar629_freshnessCounter_manyCID.c, ar629_freshnessCounter_manyCID.cs, ar629_independent_mode.c, ar629_independent_mode.cs, ar629_updating_data_sampling.c, ar629_updating_data_sampling.cs, 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, ar708_tx_error_injection.cs, ascb_bc.c, ascb_user.c, canbus_periodic.c, canbus_sampling.c, csdb_buffer_threshold.c, csdb_buffer_threshold.cs, csdb_periodic.c, csdb_periodic.cs, csdb_rx_acquisition_trigger.c, csdb_rx_acquisition_trigger.cs, csdb_rx_event_handler.c, csdb_rx_event_handler.cs, csdb_rx_sampling.c, csdb_rx_sampling.cs, mil1553_aperiodic_frame.c, mil1553_aperiodic_frame.cs, mil1553_bc.c, mil1553_bc.cs, mil1553_bc_buserror_trigger.c, mil1553_bc_buserror_trigger.cs, mil1553_bc_dual_major_frame.c, mil1553_bc_dual_major_frame.cs, mil1553_bc_extclock.c, mil1553_bc_extclock.cs, mil1553_bc_rt_data_assignment.c, mil1553_bc_rt_data_assignment.cs, mil1553_cond_branch_1.c, mil1553_cond_branch_1.cs, mil1553_cond_branch_2.c, mil1553_cond_branch_2.cs, mil1553_ebr.c, mil1553_ebr.cs, mil1553_embedded_async_to_1553.c, mil1553_embedded_update_embedded.c, mil1553_errors.c, mil1553_errors.cs, mil1553_manyErrorInjections.c, mil1553_manyErrorInjections.cs, mil1553_rt.c, mil1553_rt.cs, mil1553_rt_rt.c, mil1553_rt_rt.cs, mil1553_rtErrorInjections.c, mil1553_rtErrorInjections.cs, multi.c, multi.cs, usb.c, and usb.cs.
uint32 mxfTxPeriodicUpdateMsgBufferGet ( HMXF_CHANNEL  channel,
uint64  bufferIndex,
HMXF_BUFFER *  buffer 
)
C#
public static extern UInt32 mxfTxPeriodicUpdateMsgBufferGet(UInt64 channel, UInt64 bufferIndex, out UInt64 buffer);

Returns, based on the channel / buffer index, the allocated buffer handle for a periodic update message buffer.

Parameters
[in]channelchannel handle.
[in]bufferIndexindex of the buffer to get.
[out]bufferhandle of periodic update 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
mxfTxPeriodicUpdateMsgBufferAlloc()
Examples:
ascb_bc.c, and ascb_user.c.
uint32 mxfTxPeriodicUpdateMsgBufferFree ( HMXF_BUFFER  buffer)
C#
public static extern UInt32 mxfTxPeriodicUpdateMsgBufferFree(UInt64 buffer);

Deallocates the memory previously allocated by mxfTxPeriodicUpdateMsgBufferAlloc().

Parameters
[in]bufferbuffer handle.
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
mxfTxPeriodicUpdateMsgBufferAlloc()
Examples:
ar429_buffer_threshold.c, ar429_buffer_threshold.cs, ar429_embedded_recorder.c, ar429_embedded_recorder.cs, ar429_periodic.c, ar429_rx_acquisition_trigger.c, ar429_rx_acquisition_trigger.cs, ar429_rx_event_handler.c, ar429_rx_event_handler.cs, ar429_rx_sampling.c, ar429_rx_sampling.cs, ar629_aperiodic_frame.c, ar629_aperiodic_frame.cs, ar629_block_mode.c, ar629_block_mode.cs, ar629_dual_xpp.c, ar629_dual_xpp.cs, ar629_error_injection_detection.c, ar629_error_injection_detection.cs, ar629_freshnessCounter_manyCID.c, ar629_freshnessCounter_manyCID.cs, ar629_updating_data_sampling.c, ar629_updating_data_sampling.cs, ar708_buffer_threshold.c, ar708_periodic.c, ar708_sampling.c, ar708_tx_error_injection.c, ascb_bc.c, ascb_user.c, canbus_periodic.c, canbus_sampling.c, csdb_periodic.c, csdb_periodic.cs, mil1553_aperiodic_frame.c, mil1553_aperiodic_frame.cs, mil1553_bc.c, mil1553_bc.cs, mil1553_bc_buserror_trigger.c, mil1553_bc_buserror_trigger.cs, mil1553_bc_dual_major_frame.c, mil1553_bc_dual_major_frame.cs, mil1553_bc_extclock.c, mil1553_bc_extclock.cs, mil1553_bc_rt_data_assignment.c, mil1553_bc_rt_data_assignment.cs, mil1553_cond_branch_1.c, mil1553_cond_branch_1.cs, mil1553_cond_branch_2.c, mil1553_cond_branch_2.cs, mil1553_ebr.c, mil1553_ebr.cs, mil1553_errors.c, mil1553_errors.cs, mil1553_manyErrorInjections.c, mil1553_manyErrorInjections.cs, mil1553_rt.c, mil1553_rt.cs, mil1553_rt_rt.c, mil1553_rt_rt.cs, mil1553_rtErrorInjections.c, and mil1553_rtErrorInjections.cs.
uint32 mxfTxPeriodicUpdateMsgBufferStatusGet ( HMXF_BUFFER  buffer,
uint64 *  msgCount,
uint64 *  pendingBytes,
uint64 *  freeBytes 
)
C#
public static extern UInt32 mxfTxPeriodicUpdateMsgBufferStatusGet(UInt64 buffer, out UInt64 msgCount, out UInt64 pendingBytes, out UInt64 freeBytes);

Returns the current buffer usage (message count, used bytes, free bytes) for an allocated periodic update message buffer area.

Parameters
[in]bufferbuffer handle.
[out]msgCountnumber of messages pending in the buffer.
[out]pendingBytesnumber of pending bytes.
[out]freeBytesnumber of free bytes.
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
mxfTxPeriodicUpdateMsgBufferAlloc()
mxfTxPeriodicUpdateMsgWrite()
mxfTxPeriodicUpdateMsgClear()
uint32 mxfTxPeriodicUpdateMsgBufferInfoGet ( HMXF_BUFFER  buffer,
HMXF_CHANNEL *  channel,
uint64 *  bufferIndex 
)
C#
public static extern UInt32 mxfTxPeriodicUpdateMsgBufferInfoGet(UInt64 buffer, out UInt64 channel, out UInt64 bufferIndex);

Returns the channel and buffer index associated to a buffer for a periodic update message transmission.

Parameters
[in]bufferbuffer handle.
[out]channelchannel handle. Pass NULL to ignore this parameter.
[out]bufferIndexbuffer index. Pass NULL to ignore this parameter.
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
mxfTxPeriodicUpdateMsgBufferAlloc()
uint32 mxfTxPeriodicUpdateMsgWrite ( HMXF_BUFFER  buffer,
uint64  count,
void *  rec 
)
C#
public static extern UInt32 mxfTxPeriodicUpdateMsgWrite(UInt64 buffer, UInt64 count, IntPtr rec);

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

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 mxfNextRecordPtrGet() function. The supported records are:
Channel class TX Periodic Update record structure
ARINC 429 MXF_A429_DATAREC
MIL-STD-1553 MXF_MIL1553_DATAREC
CSDB MXF_CSDB_DATAREC
ARINC 629 MXF_A629_DATAREC
ARINC 708 MXF_A708_DATAREC
ARINC 664 MXF_A664_DATAREC
CAN MXF_CANBUS_DATAREC
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
mxfTxPeriodicUpdateMsgBufferAlloc()
mxfTxPeriodicUpdateMsgBufferStatusGet()
mxfTxPeriodicUpdateMsgClear()
mxfTxPeriodicUpdateMsgWriteAsync()
mxfTxPeriodicUpdateMsgUpdate()
Examples:
ar429_rx_acquisition_trigger.c, ar429_rx_acquisition_trigger.cs, csdb_rx_acquisition_trigger.c, csdb_rx_acquisition_trigger.cs, multi.c, and multi.cs.
uint32 mxfTxPeriodicUpdateMsgWriteAsync ( HMXF_BUFFER  buffer,
uint64  count,
void *  hostBuffer,
MXF_ASYNCHRONOUS_CALLBACK  writeCompletion,
void *  context 
)
C#
public static extern UInt32 mxfTxPeriodicUpdateMsgWriteAsync(UInt64 buffer, UInt64 count, IntPtr hostBuffer, MXF_ASYNCHRONOUS_CALLBACK writeCompletion, IntPtr context);

Writes asynchronously messages of the record array into the specified buffer. The function will return immediately after it has been registered to be executed by another thread. A callback function will be called when the asynchronous function has finished. A maximum of 1000 asynchronous function calls can be queued.

The last message of each buffer is sent continuously until a new message is written into the buffer.

Parameters
[in]bufferbuffer handle.
[in]countcount of records to write.
[in]hostBufferarray of record(s) to write. The records in the buffer need to be indexed using mxfNextRecordPtrGet() function. The supported records are:
Channel class TX Periodic Update record structure
ARINC 429 MXF_A429_DATAREC
MIL-STD-1553 MXF_MIL1553_DATAREC
CSDB MXF_CSDB_DATAREC
ARINC 629 MXF_A629_DATAREC
ARINC 708 MXF_A708_DATAREC
ARINC 664 MXF_A664_DATAREC
CAN MXF_CANBUS_DATAREC
[in]writeCompletioncallback function to be called when write process has been completed. Callback function is defined as follow:
1 typedef void (*MXF_ASYNCHRONOUS_CALLBACK)(HMXF_BUFFER bufferHandle, uint32 result, void* context, uint64* output);
[in] bufferHandle: buffer handle.
[in] result: return code of the function.
[in] context: pointer to a value that has been passed for the callback.
[in] output: array of additional information. output[0] contains the number of records to write.
[in]contextpointer to a value that will be passed to the callback handler (optional).
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()
uint32 mxfTxPeriodicUpdateMsgUpdate ( uint64  options,
uint64  count,
MXF_MSG_UPDATE_DATAREC  rec[] 
)
C#
public static extern UInt32 mxfTxPeriodicUpdateMsgUpdate(UInt64 options, UInt64 count, MXF_MSG_UPDATE_DATAREC[] rec);

Allows to update many buffers in one function call.

There is a limit of a little less than 1MB for the total size of rec.

Parameters
[in]optionsReserved for future use, must be 0.
[in]countcount of MXF_MSG_UPDATE_DATAREC in rec.
[in]recarray of MXF_MSG_UPDATE_DATAREC that contain the data to update.
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.5.7 and later.
See also
mxfTxPeriodicUpdateMsgWrite()
uint32 mxfTxPeriodicUpdateMsgClear ( HMXF_BUFFER  buffer,
uint64  options 
)
C#
public static extern UInt32 mxfTxPeriodicUpdateMsgClear(UInt64 handle, UInt64 options);

Clears the specified periodic update message buffer.

Parameters
[in]bufferbuffer handle.
[in]optionsoption.
Constant Definition
MXF_TXPERIODIC_UPDATEMSG_CLEAR_OPT_DEFAULT Clears all messages in the buffer.
MXF_TXPERIODIC_UPDATEMSG_CLEAR_OPT_WAIT Clears all messages in the buffer, but wait for the end of the repeat count of the current message before clearing it.
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
mxfTxPeriodicUpdateMsgBufferAlloc()
mxfTxPeriodicUpdateMsgBufferStatusGet()
mxfTxPeriodicUpdateMsgWrite()
Examples:
ascb_user.c, mil1553_bc_rt_data_assignment.c, mil1553_bc_rt_data_assignment.cs, mil1553_cond_branch_1.c, and mil1553_cond_branch_1.cs.
uint32 mxfTxPeriodicUpdateMsgChannelAsyncEventInit ( HMXF_CHANNEL  channel,
uint64  almostEmpty,
void *  context,
MXF_ASYNCEVENT_BUFFER_HANDLER  callback 
)
C#
public static extern UInt32 mxfTxPeriodicUpdateMsgChannelAsyncEventInit(UInt64 channel, UInt64 almostEmpty, IntPtr context, MXF_ASYNCEVENT_BUFFER_HANDLER callback);

Sets an async event handler for a Tx Periodic Update Msg channel. When the almost empty threshold will be reached, the callback will be called once and will be called again only when the almost empty threshold will be reached again. The messages are selected by using mxfTxPeriodicUpdateMsgChannelAsyncEventSelectSet().

Parameters
[in]channelTx Periodic Update Msg channel handle
[in]almostEmptyalmost empty threshold value
[in]contexthandler callback context
[in]callbackTx Periodic Update Msg buffer callback handler

The callback handler function is defined as follow:

1 typedef uint32 (*MXF_ASYNCEVENT_BUFFER_HANDLER)(HMXF_BUFFER buffer, void* context);

[in] buffer: buffer handle [in] context: context pointer

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.3.1 and later.
See also
mxfTxPeriodicUpdateMsgChannelAsyncEventTerminate()
mxfAsyncEventConditionsSet()
uint32 mxfTxPeriodicUpdateMsgChannelAsyncEventTerminate ( HMXF_CHANNEL  channel)
C#
public static extern mxfTxPeriodicUpdateMsgChannelAsyncEventTerminate(UInt64 channel);

Clears the async event handler for a Tx Periodic Update Msg channel.

Parameters
[in]channelTx Periodic Update Msg buffer channel
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.3.1 and later.
See also
mxfTxPeriodicUpdateMsgChannelAsyncEventInit()
mxfAsyncEventConditionsSet()
uint32 mxfTxPeriodicUpdateMsgChannelAsyncEventSelectSet ( HMXF_CHANNEL  channel,
uint64  select,
uint64  count,
HMXF_BUFFER *  bufferArray 
)
C#
public static extern mxfTxPeriodicUpdateMsgChannelAsyncEventSelectSet(UInt64 channel, UInt64 select, UInt64 count, UInt64[] bufferArray);

Selects or deselects the TX periodic update message buffers for Tx Periodic Update Msg condition on a specified TX channel.

This function must be called in addition to mxfTxPeriodicUpdateMsgChannelAsyncEventInit() to cause an asynchronous event to occur when a specific TX periodic update message buffer threshold is reached.

Note
count set to 0 with a msg set to NULL means ALL message IDs.
Parameters
[in]channelchannel handle
[in]selectaction to perform for the message IDs
Action Description
MXF_MSG_DESELECT Deselects the message IDs
MXF_MSG_SELECT_ADD Adds the specified message IDs
MXF_MSG_SELECT_ONLY Replaces the current selection with the provided list
[in]countnumber of buffers
[in]bufferArrayhandle to buffer(s) arrays
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.3.1 and later.
See also
mxfTxPeriodicUpdateMsgChannelAsyncEventSelectGet()
mxfAsyncEventConditionsSet()
uint32 mxfTxPeriodicUpdateMsgChannelAsyncEventSelectGet ( HMXF_CHANNEL  channel,
uint64  maxCount,
uint64 *  count,
HMXF_BUFFER *  bufferArray 
)
C#
public static extern mxfTxPeriodicUpdateMsgChannelAsyncEventSelectGet(UInt64 channel, UInt64 maxCount, out UInt64 count, UInt64[] bufferArray);

Returns the list of buffers registered for a specified TX channel for x Periodic Update Msg asynchronous event condition.

Parameters
[in]channelchannel handle
[in]maxCountmaximum of buffers expected
[out]countnumber of buffers returned
[out]bufferArrayhandle to buffer(s) arrays
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.3.1 and later.
See also
mxfTxPeriodicUpdateMsgChannelAsyncEventSelectSet()
mxfAsyncEventConditionsSet()
uint32 mxfTxErrChannelAsyncEventInit ( HMXF_CHANNEL  channel,
void *  context,
MXF_ASYNCEVENT_TXERR_HANDLER  callback 
)
C#
public static extern mxfTxErrChannelAsyncEventInit(UInt64 channel, IntPtr context, MXF_ASYNCEVENT_TXERR_HANDLER callback);

Sets an async event handler for a Tx Error. When an error will be detected, the callback will be called once and will be called again only when another error will be detected.

Parameters
[in]channelTx channel handle
[in]contexthandler callback context
[in]callbackTx Err buffer callback handler

The callback handler function is defined as follow:

1 typedef uint32 (*MXF_ASYNCEVENT_TXERR_HANDLER)(HMXF_CHANNEL channel, uint64 status, void* context);

[in] channel: channel handle [in] status: detected error [in] context: context pointer

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.3.1 and later.
See also
mxfRxErrChannelAsyncEventTerminate()
mxfAsyncEventConditionsSet()
uint32 mxfTxErrChannelAsyncEventTerminate ( HMXF_CHANNEL  channel)
C#
public static extern mxfTxErrChannelAsyncEventTerminate(UInt64 channel);

Clears the async event handler for a Tx Error.

Parameters
[in]channelTx channel handle
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.3.1 and later.
See also
mxfRxErrChannelAsyncEventInit()
mxfAsyncEventConditionsSet()
Updated 10/23/2023