MX Foundation 4
Application and Resources

Functions

uint32 mxfAttributeCountGet (HMXF_HANDLE handle, uint64 *count)
 
uint32 mxfAttributeListGet (HMXF_HANDLE handle, uint64 maxCount, uint64 *count, uint64 *attribList)
 
uint32 mxfAttributeInfoGet (HMXF_HANDLE handle, uint64 attrib, MXF_ATTRIBUTE_INFO *info)
 
uint32 mxfAttributeInfoDetailsGet (HMXF_HANDLE handle, uint64 attrib, void *info)
 
uint32 mxfAttributeUint64Set (HMXF_HANDLE handle, uint64 attrib, uint64 value)
 
uint32 mxfAttributeUint64Get (HMXF_HANDLE handle, uint64 attrib, uint64 *value)
 
uint32 mxfAttributeDoubleSet (HMXF_HANDLE handle, uint64 attrib, double value)
 
uint32 mxfAttributeDoubleGet (HMXF_HANDLE handle, uint64 attrib, double *value)
 
uint32 mxfChannelMsgAttributeUint64Set (HMXF_CHANNEL channel, uint64 attrib, void *msg, uint64 value)
 
uint32 mxfChannelMsgAttributeUint64Get (HMXF_CHANNEL channel, uint64 attrib, void *msg, uint64 *value)
 
uint32 mxfSystemApplicationCountGet (HMXF_SERVER server, uint64 *count)
 
uint32 mxfSoftInfoCountGet (HMXF_SERVER server, uint64 *count)
 
uint32 mxfSoftInfoGet (HMXF_SERVER server, uint64 maxCount, uint64 *count, MXF_SOFT_INFO *info)
 
uint32 mxfSystemNameSet (HMXF_SERVER server, const char *name)
 
uint32 mxfSystemNameGet (HMXF_SERVER server, uint64 size, char *name)
 
uint32 mxfBonjourIdGet (HMXF_SERVER server, uint64 size, char *name)
 
uint32 mxfSystemResourcesInit (HMXF_SERVER server, uint64 options)
 
uint32 mxfSystemResourcesRelease (HMXF_SERVER server, uint64 options)
 
uint32 mxfFlexMultiReset (HMXF_SERVER server)
 

Detailed Description

Function Documentation

uint32 mxfAttributeCountGet ( HMXF_HANDLE  handle,
uint64 *  count 
)
C#
public static extern UInt32 mxfAttributeCountGet(UInt64 handle, out UInt64 count);

Returns the number of attributes defined for the specified device, module or channel.

Parameters
[in]handlehandle of the object to enumerate
  • HMXF_DEVICE: Device handle
  • HMXF_MODULE: Module handle
  • HMXF_CHANNEL: Channel handle
  • HMXF_VL: Virtual Link handle (ARINC 664)
    • HMXF_PORT: COM / SAP handle (ARINC 664)
[out]countnumber of attributes
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
mxfAttributeListGet()
mxfAttributeInfoGet()
mxfAttributeInfoDetailsGet()
uint32 mxfAttributeListGet ( HMXF_HANDLE  handle,
uint64  maxCount,
uint64 *  count,
uint64 *  attribList 
)
C#
public static extern UInt32 mxfAttributeListGet(UInt64 handle, UInt64 maxCount, out UInt64 count, [Out] UInt64[] attribList);

Returns the list of attributes identification defined for the specified device, module, or channel.

Parameters
[in]handlehandle of the object to enumerate.
  • HMXF_DEVICE: Device handle
  • HMXF_MODULE: Module handle
  • HMXF_CHANNEL: Channel handle
  • HMXF_VL: Virtual Link handle (ARINC 664)
    • HMXF_PORT: COM / SAP handle (ARINC 664)
[in]maxCountmaximum number of attribute IDs to return (sizeof attribList)
[out]countnumber of attributes returned in attribList
[out]attribListlist of attributes.

The returned attribList values are IDs of the attributes that can be used as attrib parameter for the other attribute functions.

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
mxfAttributeCountGet()
mxfAttributeInfoGet()
mxfAttributeInfoDetailsGet()
uint32 mxfAttributeInfoGet ( HMXF_HANDLE  handle,
uint64  attrib,
MXF_ATTRIBUTE_INFO info 
)
C#
public static extern UInt32 mxfAttributeInfoGet(UInt64 handle, UInt64 attrib, out MXF_ATTRIBUTE_INFO info);

Returns the attribute information for the specified device, module, or channel.

Parameters
[in]handlehandle of the object to enumerate.
  • HMXF_DEVICE: Device handle
  • HMXF_MODULE: Module handle
  • HMXF_CHANNEL: Channel handle
  • HMXF_VL: Virtual Link handle (ARINC 664)
    • HMXF_PORT: COM / SAP handle (ARINC 664)
[in]attribattribute ID to get information for.
[out]infopointer to MXF_ATTRIBUTE_INFO structure.
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
mxfAttributeCountGet()
mxfAttributeListGet()
mxfAttributeInfoDetailsGet()
uint32 mxfAttributeInfoDetailsGet ( HMXF_HANDLE  handle,
uint64  attrib,
void *  info 
)
C#
public static extern UInt32 mxfAttributeInfoDetailsGet(UInt64 handle, UInt64 attrib, out MXF_ATTRIBUTE_INFO_UINT64_DETAILS_BITMASK details);

Returns the detailed attribute information for the specified device, module, or channel.

This information can be, for instance, range information (minimum, maximum value that can be set), valid enumeration or bitmasks.

Parameters
[in]handlehandle of the object to enumerate.
  • HMXF_DEVICE: Device handle
  • HMXF_MODULE: Module handle
  • HMXF_CHANNEL: Channel handle
  • HMXF_VL: Virtual Link handle (ARINC 664)
  • HMXF_PORT: COM / SAP handle (ARINC 664)
[in]attribattribute ID to get detailed information for.
[out]infopointer to detailed information structure. The structure depends on the type of the attribute. The attribute type is available in MXF_ATTRIBUTE_INFO.type from mxfAttributeInfoGet().
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
mxfAttributeCountGet()
mxfAttributeListGet()
mxfAttributeInfoGet()
uint32 mxfAttributeUint64Set ( HMXF_HANDLE  handle,
uint64  attrib,
uint64  value 
)
C#
public static extern UInt32 mxfAttributeUint64Set(UInt64 handle, UInt64 attrib, UInt64 value);

Sets an attribute value specific to the handle. The value is 64 bits integer unsigned.

The attribute type is available in MXF_ATTRIBUTE_INFO.type from mxfAttributeInfoGet().

Parameters
[in]handlehandle reference
Constant Description
MXF_SERVER Server handle
HMXF_DEVICE Device handle
HMXF_MODULE Module handle
HMXF_PORT COM / SAP handle (ARINC 664)
HMXF_VL Virtual Link handle (ARINC 664)
HMXF_BUFFER VL/SubVL buffer (ARINC 664)
[in]attribattribute identification.

Refer to the specific sections below for the exhaustive list of attributes for each modules and channels;
[in]valuevalue to set
Note
To set a floating point attribute value, use mxfAttributeDoubleGet().
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
mxfAttributeDoubleSet()
mxfAttributeInfoGet()
mxfAttributeUint64Get()
Examples:
adc.c, adc_buffer_threshold.c, adc_internal_calib.c, adc_sampling.c, ar429_aperiodic.c, ar429_aperiodic.cs, ar429_buffer_threshold.c, ar429_buffer_threshold.cs, ar429_embedded_bridge.c, ar429_embedded_bridge.cs, ar429_embedded_discrete.c, ar429_embedded_discrete.cs, ar429_embedded_recorder.c, ar429_embedded_recorder.cs, ar429_embedded_timer.c, ar429_embedded_timer.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, ar429_UDPCommRxEmbedded.c, ar629_alternate.c, ar629_alternate.cs, ar629_aperiodic_frame.c, ar629_aperiodic_frame.cs, ar629_aperiodic_mode.c, ar629_aperiodic_mode.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, ar664_aperiodicSap.c, ar664_aperiodicSap.cs, ar664_com_queuing_basic.c, ar664_com_queuing_basic.cs, ar664_end_system.c, ar664_end_system.cs, ar664_error_injection_detection.c, ar664_error_injection_detection.cs, ar664_error_injection_detection_ede.c, ar664_error_injection_detection_ede.cs, ar664_playback.c, ar664_playback.cs, ar664_raw_rx.c, ar664_raw_rx.cs, ar664_recorder.c, ar664_recorder.cs, ar664_sampling.c, ar664_sampling.cs, 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, ar708_tx_error_injection.cs, ar717.c, ar717.cs, ar717_advance.c, ar717_advance.cs, ar717_bridge_from_ar429.c, ar717_bridge_from_ar429.cs, ar717_buffer_threshold.c, ar717_buffer_threshold.cs, ar717_embedded_recorder.c, ar717_embedded_recorder.cs, ar717_rx_acquisition_trigger.c, ar717_rx_acquisition_trigger.cs, ascb_bc.c, ascb_bm.c, ascb_user.c, async.c, async.cs, async_flow_control_hw.c, async_flow_control_hw.cs, async_flow_control_sw.c, async_flow_control_sw.cs, async_rx_acquisition_trigger.c, async_rx_acquisition_trigger.cs, async_tx_error_injection.c, async_tx_error_injection.cs, can_fd.c, csdb_aperiodic.c, csdb_aperiodic.cs, 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, dac.c, dac_buffer_threshold.c, dac_relative_timing.c, discrete_event_handler.c, discrete_event_handler.cs, discrete_fifo.c, discrete_fifo.cs, discrete_rx_acquisition_trigger.c, discrete_rx_acquisition_trigger.cs, flexadc.c, flexadc_buffer_threshold.c, flexadc_sampling.c, flexdac.c, flexdac_buffer_threshold.c, flexdac_relative_timing.c, flexdio_event_handler.c, flexdio_fifo.c, flexdio_fifo_sampling.c, flexdio_sampling_acq.c, flexdio_sync.c, hdlc.c, hdlc.cs, hdlc_aperiodic.c, hdlc_aperiodic.cs, hdlc_buffer_threshold.c, hdlc_buffer_threshold.cs, hdlc_trigger.c, hdlc_trigger.cs, hdlc_tx_error_injection.c, hdlc_tx_error_injection.cs, hfce.c, hfce_aperiodic.c, hfce_buffer_threshold.c, hfce_trigger.c, hfce_tx_error_injection.c, irigb_1pps.c, irigb_1pps.cs, mil1553_aperiodic.c, mil1553_aperiodic.cs, mil1553_aperiodic_event.c, mil1553_aperiodic_event.cs, mil1553_aperiodic_frame.c, mil1553_aperiodic_frame.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_bm.c, mil1553_bm_acquisition_trigger.c, mil1553_bm_acquisition_trigger.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_async_to_1553.cs, mil1553_embedded_update_host.c, mil1553_embedded_update_host.cs, mil1553_errors.c, mil1553_errors.cs, mil1553_manyErrorInjections.c, mil1553_manyErrorInjections.cs, mil1553_rt_rt.c, mil1553_rt_rt.cs, mil1553_rtErrorInjections.c, mil1553_rtErrorInjections.cs, multi.c, multi.cs, pulse.c, usb.c, usb.cs, write_read_async.c, and write_read_async.cs.
uint32 mxfAttributeUint64Get ( HMXF_HANDLE  handle,
uint64  attrib,
uint64 *  value 
)
C#
public static extern UInt32 mxfAttributeUint64Get(UInt64 handle, UInt64 attrib, out UInt64 value);

Returns the value an attribute specific for the handle. The value is 64 bits integer unsigned.

The attribute type is available in MXF_ATTRIBUTE_INFO.type from mxfAttributeInfoGet().

Parameters
[in]handlehandle reference
Constant Description
MXF_SERVER Server handle
HMXF_DEVICE Device handle
HMXF_MODULE Module handle
HMXF_PORT COM / SAP handle (ARINC 664)
HMXF_VL Virtual Link handle (ARINC 664)
HMXF_BUFFER VL/SubVL buffer (ARINC 664)
[in]attribattribute identification.

Refer to the specific sections below for the exhaustive list of attributes;
[out]valuepointer to returned value
Note
To return a floating point attribute, use mxfAttributeDoubleGet().
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.

Common Attributes


Device Attributes

Each device supports the following attribute:

Device Type

The KMXF_DEVICE_TYPE attribute holds the device type (read-only).

Constant Description
MXF_DEVICE_FLEX1553_PCIE Flex1553-PCIe
MXF_DEVICE_FLEXMULTI_1553 FlexMulti 1553
MXF_DEVICE_FLEXMULTI_629 FlexMulti 629
MXF_DEVICE_FLEXMULTI_429 FlexMulti 429
MXF_DEVICE_FLEXMULTI_664 FlexMulti 664
MXF_DEVICE_FLEXMULTI FlexMulti
MXF_DEVICE_PCIE502 PCIe 502 carrier
MXF_DEVICE_PXIE500 PXIe 500 carrier
MXF_DEVICE_FMOB429_PLUS FlexMobile 429+
MXF_DEVICE_PMC429 MAXPMC 429
MXF_DEVICE_XMC429 MAXXMC 429


Common Module Attributes

Each module supports the following attributes:

Module Type

The KMXF_MODULE_TYPE attribute holds the module type (read-only).

Constant Description
MXF_MODULE_A429_EH ARINC 429 Enhanced module
MXF_MODULE_MIL1553MRT_EH MIL-1553 Enhanced module
MXF_MODULE_ASYNC_EH ASYNC Enhanced module
MXF_MODULE_DIOFIFO_EH Discrete input / discrete output Enhanced module
MXF_MODULE_MULTI_EH Multi-protocol Enhanced module
MXF_MODULE_A629MRT_EH ARINC 629 Enhanced module
MXF_MODULE_A708_EH ARINC 708 Enhanced module
MXF_MODULE_CANBUS CAN bus module
MXF_MODULE_A664 ARINC 664 module
MXF_MODULE_A429E IPM-429 module
MXF_MODULE_ADC IPM-ADC module
MXF_MODULE_ASYNC IPM-ASYNC module
MXF_MODULE_A708 IPM-708 module
MXF_MODULE_A629MRT_REV2 IPM-629 module
MXF_MODULE_MULTI IPM-MULTI module
MXF_MODULE_HFCE IPM-HFCE module
MXF_MODULE_MIL1553MRT IPM-1553-MRT module
MXF_MODULE_DIO48 IPM-DIO-48 module
MXF_MODULE_DIOFIFO48 IPM-DIO-FIFO-48 module
MXF_MODULE_ASCBMRT IPM-ASCB module
MXF_MODULE_DIOFIFO24DIFF IPM-DIO-24 module


Module Version

The KMXF_MODULE_VERSION attribute holds the module version of programmed VHDL code (read-only).


Module Options

The KMXF_MODULE_OPTIONS attribute holds the module options of programmed VHDL code (read-only).



Common Channel Attributes

Each channel supports the following attributes:

Channel Class

The KMXF_CHANNEL_CLASS attribute holds the channel class of the channel. To change channel class of channel that supports more than one channel class, use mxfSystemInitAttributeUint64CallbackHandler() initialization handler.

Note
Since MXF 4.5.2, it is now possible to change the channel class by using mxfAttributeUint64Set() instead of using the initialization handler.
Constant Description
MXF_CLASS_A429 A429 Channel
MXF_CLASS_CSDB CSDB Channel
MXF_CLASS_DISCRETE Discrete Channel
MXF_CLASS_A629 A629 Channel
MXF_CLASS_MIL1553 MIL1553 Channel
MXF_CLASS_A717 A717 Channel
MXF_CLASS_A708 A708 Channel
MXF_CLASS_HDLC HDLC Channel
MXF_CLASS_CLOCK CLOCK Channel
MXF_CLASS_HANDSHAKE Handshake Channel
MXF_CLASS_ASYNC_ENHANCED ASYNC Enhanced Channel
MXF_CLASS_CANBUS CAN bus Channel
MXF_CLASS_A664 A664 Channel
MXF_CLASS_ANALOG Analog Channel
MXF_CLASS_HFCE HFCE Channel
MXF_CLASS_ASCB ASCB Channel
MXF_CLASS_PULSE Pulse Channel


Channel Subclass

The KMXF_CHANNEL_SUBCLASS attribute holds the supported subclass of the channel (read-only).

Constant Description
MXF_SCLASS_RX_CHANNEL Channel is RX
MXF_SCLASS_TX_CHANNEL Channel is TX
MXF_SCLASS_BM_CHANNEL Channel is BM
MXF_SCLASS_BC_CHANNEL Channel is BC
MXF_SCLASS_RT_CHANNEL Channel is RT
MXF_SCLASS_RXACQ_SRV Channel supports RX acquisition
MXF_SCLASS_RXSAMPLING_SRV Channel supports RX sampling
MXF_SCLASS_TXAPERIODIC_SRV Channel supports TX aperiodic
MXF_SCLASS_TXPERIODIC_MJRFRAME_SRV Channel supports TX periodic frame
MXF_SCLASS_TXPERIODIC_UPDATEMSG_SRV Channel supports TX periodic update message
MXF_SCLASS_TXPERIODIC_SCHEDULE_SRV Channel supports TX periodic schedule


Server Attributes


Ethernet Server supports the following attributes:

Keep Alive

The KMXF_SERVER_KEEP_ALIVE attribute holds the keep alive mechanism state. When enabled, connection timeout is fired if no activity has been detected for 60 seconds. Network timeout condition can happen when debugging an Ethernet application and staying on a breakpoint for longer than the timeout value. In that case, disabling the keep alive mechanism will avoid this condition.

Constant Description
VMXF_ENABLE Keep alive is enabled (default)
VMXF_DISABLE Keep alive is disabled


Allow Reconnection

When enabled, the KMXF_SERVER_ALLOW_RECONNECTION_EXCLUSIVE_CLIENT attribute allows an exclusive client to reconnect. This can be useful in development when the application is run in a container and terminates improperly without calling mxfServerDisconnect(), but the process is still alive (VIs in LabVIEW are such a case). This attribute is global to the server, so any client can change it.

Constant Description
VMXF_ENABLE Reconnection is allowed
VMXF_DISABLE Reconnection is not allowed (default)


Device Attributes


Device may support the following attributes:

Sync-Out Termination

The KMXF_DEVICE_SYNC_OUT_TERMINATION attribute holds the sync-out termination state. 120 ohm termination resistor can be added by changing this attribute.
Only available on PMC/XMC devices.

Constant Description
VMXF_DEVICE_SYNC_OUT_TERMINATION_NONE No termination resistor (default)
VMXF_DEVICE_SYNC_OUT_TERMINATION_120OHM 120 ohm termination resistor is added


Sync-In Termination

The KMXF_DEVICE_SYNC_IN_TERMINATION attribute holds the sync-in termination state. 100 or 120 ohm termination resistor can be added by changing this attribute.
Only available on PMC/XMC devices.

Constant Description
VMXF_DEVICE_SYNC_IN_TERMINATION_NONE No termination resistor (default)
VMXF_DEVICE_SYNC_IN_TERMINATION_120OHM 120 ohm termination resistor is added
VMXF_DEVICE_SYNC_IN_TERMINATION_100OHM 100 ohm termination resistor is added


Availability:
Available in MX Foundation 4.0 and later.
See also
mxfAttributeUint64Set()
mxfAttributeInfoGet()
mxfAttributeDoubleGet()
Examples:
ar429_buffer_threshold.c, ar429_embedded_bridge.c, ar429_embedded_timer.c, ar429_embedded_timer.cs, ar429_rx_event_handler.c, ar429_rx_sampling.c, async_rx_acquisition_trigger.c, async_rx_acquisition_trigger.cs, discrete_event_handler.c, discrete_event_handler.cs, discrete_fifo.c, discrete_fifo.cs, discrete_rx_acquisition_trigger.c, discrete_rx_acquisition_trigger.cs, mil1553_aperiodic.c, and mil1553_aperiodic.cs.
uint32 mxfAttributeDoubleSet ( HMXF_HANDLE  handle,
uint64  attrib,
double  value 
)
C#
public static extern UInt32 mxfAttributeDoubleSet(UInt64 handle, UInt64 attrib, double value);

Sets the value (double) of an attribute. For unsigned attribute, use mxfAttributeUint64Set(). The attribute type is available in MXF_ATTRIBUTE_INFO.type from mxfAttributeInfoGet().

Parameters
[in]handlehandle reference
Constant Description
MXF_SERVER Server handle
HMXF_DEVICE Device handle
HMXF_MODULE Module handle
HMXF_PORT COM / SAP handle (ARINC 664)
HMXF_VL Virtual Link handle (ARINC 664)
HMXF_BUFFER VL/SubVL buffer (ARINC 664)
[in]attribattribute identification.

Refer to the specific sections below for the exhaustive list of attributes;
[in]valuevalue to set
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
mxfAttributeDoubleGet()
mxfAttributeInfoGet()
mxfAttributeUint64Set()
Examples:
adc_internal_calib.c, dac_relative_timing.c, and pulse.c.
uint32 mxfAttributeDoubleGet ( HMXF_HANDLE  handle,
uint64  attrib,
double *  value 
)
C#
public static extern UInt32 mxfAttributeDoubleGet(UInt64 handle, UInt64 attrib, out double value);

Returns the value (double) of an attribute. For unsigned attribute, use mxfAttributeUint64Get(). The attribute type is available in MXF_ATTRIBUTE_INFO.type from mxfAttributeInfoGet().

Parameters
[in]handlehandle reference
Constant Description
MXF_SERVER Server handle
HMXF_DEVICE Device handle
HMXF_MODULE Module handle
HMXF_PORT COM / SAP handle (ARINC 664)
HMXF_VL Virtual Link handle (ARINC 664)
HMXF_BUFFER VL/SubVL buffer (ARINC 664)
[in]attribattribute identification.

Refer to the specific sections below for the exhaustive list of attributes;
[out]valuepointer to returned value
[out]valuepoints to a double variable that receives the attribute value.
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
mxfAttributeDoubleSet()
mxfAttributeInfoGet()
mxfAttributeUint64Get()
Examples:
adc_internal_calib.c.
uint32 mxfChannelMsgAttributeUint64Set ( HMXF_CHANNEL  channel,
uint64  attrib,
void *  msg,
uint64  value 
)

Sets the attribute value of the specified message ID defined on a channel.

Parameters
[in]channelchannel handle
[in]attribattribute identification.
Message Attribute ID Description
KMXF_MSG_CHECKSUM Enable/disable checksum for the message
KMXF_MSG_CRC Enable/disable CRC for the message
[in]msgmessage id (MXF_MSGID structure)
[in]valuevalue to set
Constant Description
VMXF_ENABLE Enable message attribute
VMXF_DISABLE Disable message attribute
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
mxfChannelMsgAttributeUint64Get()
uint32 mxfChannelMsgAttributeUint64Get ( HMXF_CHANNEL  channel,
uint64  attrib,
void *  msg,
uint64 *  value 
)

Returns the attribute value of the specified message ID defined on a channel.

Parameters
[in]channelchannel handle
[in]attribattribute identification.
Message Attribute ID Description
KMXF_MSG_CHECKSUM Enable/disable checksum for the message
KMXF_MSG_CRC Enable/disable CRC for the message
[in]msgmessage id (MXF_MSGID structure)
[out]valuepointer to returned value
Constant Description
VMXF_ENABLE message attribute enabled
VMXF_DISABLE message attribute disabled
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
mxfChannelMsgAttributeUint64Set()
uint32 mxfSystemApplicationCountGet ( HMXF_SERVER  server,
uint64 *  count 
)
C#
public static extern UInt32 mxfSystemApplicationCountGet(UInt64 server, out UInt64 count);

Returns the number of applications using MX Foundation that are currently running.

Parameters
[in]serverserver handle.
[out]countnumber of MX Foundation based applications currently running.
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
mxfSystemInit()
mxfSystemTerminate()
Examples:
mil1553_bc_extclock.c, and mil1553_bc_extclock.cs.
uint32 mxfSoftInfoCountGet ( HMXF_SERVER  server,
uint64 *  count 
)
C#
public static UInt32 mxfSoftInfoCountGet(UInt64 server, out UInt64 count);

Gets the number of installed software libraries.

Parameters
[in]serverServer handle
[out]countSoftware libraries count
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
mxfSoftInfoGet
uint32 mxfSoftInfoGet ( HMXF_SERVER  server,
uint64  maxCount,
uint64 *  count,
MXF_SOFT_INFO info 
)
C#
public static extern UInt32 mxfSoftInfoGet(UInt64 server, UInt64 maxCount, out UInt64 count, [Out] MXF_SOFT_INFO[] info);

Gets the installed software libraries information.

Parameters
[in]serverServer handle
[in]maxCountMaximum software information to return
[out]countSoftware information count
[out]infoSoftware information 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
mxfSoftInfoCountGet
uint32 mxfSystemNameSet ( HMXF_SERVER  server,
const char *  name 
)
C#
public static extern UInt32 mxfSystemNameSet(UInt64 server, string name);

Sets the name to be used for the system (server). This name will be used by the Bonjour service.

For remote application, this function is available to client with admin privileges.

Parameters
[in]serverserver handle.
[in]namesystem name (max 256 characters)
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
mxfSystemNameGet()
mxfBonjourIdGet()
uint32 mxfSystemNameGet ( HMXF_SERVER  server,
uint64  size,
char *  name 
)
C#
public static extern UInt32 mxfSystemNameGet(UInt64 server, UInt64 size, StringBuilder name);

Gets the name for the system (server). This name is used by the Bonjour service.

Parameters
[in]serverserver handle.
[in]sizesize of the name buffer
[out]namepointer to name 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
mxfSystemNameSet()
mxfBonjourIdGet()
uint32 mxfBonjourIdGet ( HMXF_SERVER  server,
uint64  size,
char *  name 
)
C#
public static extern UInt32 mxfBonjourIdGet(UInt64 server, UInt64 size, StringBuilder name);

Gets the Bonjour ID. This ID is used by the Bonjour service.

Parameters
[in]serverserver handle.
[in]sizesize of the name buffer
[out]namepointer to name 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
mxfSystemNameSet()
mxfSystemNameGet()
uint32 mxfSystemResourcesInit ( HMXF_SERVER  server,
uint64  options 
)
C#
public static extern UInt32 mxfSystemResourcesInit(UInt64 server, UInt64 options);

Initializes the library and allocates the base system resources. During the initialization, after the devices are detected, the firmware file is automatically loaded. When a device is configured to run in Ethernet mode, the firmware, library, server and configuration files are automatically loaded from the on-board flash, otherwise only the firmware is uploaded from the client system.

Note
If the function is performed with option MXF_SYSTEM_OPTION_RESET_DEVICES by an embedded application, the reset does not completely reset the device as this would cause it to terminate the embedded application.

Timebase is set to MXF_TIMEBASE_DEVICE_NSEC by this function.

For remote application, this function is not available to client with user privileges.

If the function returns MAXT_ERROR_MANY_MASTER, the application can continue its execution, this error is a non-fatal error.

Parameters
[in]serverserver handle
[in]optionsthe following options are available
  • MXF_SYSTEM_OPTION_RESET_DEVICES: Reset the devices. Perform the same as mxfSystemInit() 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
mxfServerConnect()
mxfSystemInit()
mxfSystemResourcesRelease()
mxfSystemInitAttributeUint64CallbackHandler()
Examples:
adc.c, ar429_aperiodic.c, ar429_aperiodic.cs, ar429_embedded_comm_queues.c, ascb_bc.c, ascb_bm.c, ascb_user.c, can_fd.c, canbus.c, canbus.cs, flexadc.c, flexdac.c, mil1553_bc.c, mil1553_bc.cs, mil1553_bc_extclock.c, mil1553_bc_extclock.cs, mil1553_bm.c, mil1553_bm.cs, mil1553_embedded_async_to_1553.c, mil1553_embedded_async_to_1553.cs, mil1553_rt.c, and mil1553_rt.cs.
uint32 mxfSystemResourcesRelease ( HMXF_SERVER  server,
uint64  options 
)
C#
public static extern UInt32 mxfSystemResourcesRelease(UInt64 server, UInt64 options);

Releases the system resources allocated by the library.

Note
If the function is performed with option MXF_SYSTEM_OPTION_RESET_DEVICES by an embedded application, the reset does not completely reset the device as this would cause it to terminate the embedded application.
It is important to disable all asynchronous event conditions and that the asynchronous event handler has finished and is terminated with mxfAsyncEventHandlerTerminate() before calling this function.

For remote application, this function is not available to client with user privileges.

Parameters
[in]serverserver handle
[in]optionsthe following options are available
  • MXF_SYSTEM_OPTION_RESET_DEVICES: Reset the devices. Perform the same as mxfSystemTerminate() 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
mxfServerConnect()
mxfSystemTerminate()
mxfSystemResourcesInit()
mxfSystemInitAttributeUint64CallbackHandler()
Examples:
adc.c, ar717_embedded_recorder.c, ar717_embedded_recorder.cs, ascb_bc.c, ascb_bm.c, ascb_user.c, mil1553_bc.c, mil1553_bc.cs, mil1553_bc_extclock.c, mil1553_bc_extclock.cs, mil1553_bm.c, mil1553_bm.cs, mil1553_embedded_async_to_1553.c, mil1553_embedded_async_to_1553.cs, mil1553_embedded_update_host.c, mil1553_embedded_update_host.cs, mil1553_rt.c, and mil1553_rt.cs.
uint32 mxfFlexMultiReset ( HMXF_SERVER  server)
C#
public static extern UInt32 mxfFlexMultiReset(UInt64 server);

Performs a hard reset of all FlexMulti devices associated to this server. This function is similar to pressing the reset button of the FlexMulti device.

This function is available for Ethernet or USB connected FlexMulti. The Ethernet or USB connection will be lost, the application will need to reconnect to the device.

Parameters
[in]serverserver 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
mxfServerConnect()
Updated 03/30/2022