MX Foundation 4

Functions

uint32 mxfDeviceModuleCountGet (HMXF_DEVICE device, uint64 moduleType, uint64 *count)
 
uint32 mxfDeviceModuleGet (HMXF_DEVICE device, uint64 index, HMXF_MODULE *module)
 
uint32 mxfDeviceModuleAllGet (HMXF_DEVICE device, uint64 type, uint64 maxCount, uint64 *count, HMXF_MODULE *modules)
 
uint32 mxfModuleCountGet (HMXF_SERVER server, uint64 moduleType, uint64 *count)
 
uint32 mxfModuleGet (HMXF_SERVER server, uint64 moduleType, uint64 moduleIndex, HMXF_MODULE *module)
 
uint32 mxfModuleAllGet (HMXF_SERVER server, uint64 moduleType, uint64 maxModule, uint64 *count, HMXF_MODULE *modules)
 

Detailed Description

Function Documentation

uint32 mxfDeviceModuleCountGet ( HMXF_DEVICE  device,
uint64  moduleType,
uint64 *  count 
)
C#
public static extern UInt32 mxfDeviceModuleCountGet(UInt64 device, UInt64 type, out UInt64 count);

Returns the number of modules detected on the device.

Parameters
[in]devicedevice handle
[in]moduleTypemodule type
Constant Description
MXF_MODULE_ALL Used to specify any modules.
MXF_MODULE_DIO48 IPM-DIO-48 module
MXF_MODULE_DAC IPM-DAC module
MXF_MODULE_A429E IPM-429 module
MXF_MODULE_DIOFIFO48 IPM-DIO-48-FIFO module
MXF_MODULE_MIL1553MRT IPM-1553-MRT module
MXF_MODULE_ASCBMRT IPM-ASCB module
MXF_MODULE_A629MRT_REV2 IPM-629 module
MXF_MODULE_MULTI IPM-MULTI module
MXF_MODULE_A708 IPM-708 module
MXF_MODULE_ADC IPM-ADC module
MXF_MODULE_DIOFIFO24DIFF IPM-DIO-24 module
MXF_MODULE_ASYNC IPM-ASYNC module
MXF_MODULE_HFCE IPM-HFCE module
MXF_MODULE_CANBUS CAN bus module
MXF_MODULE_MIL1553MRT_EH MIL-1553 Enhanced module
MXF_MODULE_A664 ARINC 664 module
MXF_MODULE_DIOFIFO_EH Discrete input / discrete output Enhanced module
MXF_MODULE_A429_EH ARINC 429 Enhanced module
MXF_MODULE_ASYNC_EH ASYNC 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_FLEXDIO FlexMAX DIO module
MXF_MODULE_FLEXDAC FlexMAX DAC module
MXF_MODULE_FLEXADC FlexMAX ADC module
MXF_MODULE_FLEX429 FlexMAX 429 module
[out]countnumber of modules detected
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
mxfDeviceModuleGet()
mxfDeviceModuleAllGet()
uint32 mxfDeviceModuleGet ( HMXF_DEVICE  device,
uint64  index,
HMXF_MODULE *  module 
)
C#
public static extern UInt32 mxfDeviceModuleGet(UInt64 device, UInt64 index, out UInt64 module);

Returns the module handle for the specified module index.

Parameters
[in]devicedevice handle
[in]indexphysical module index (e.g., 0=first module, 1=second module, ...)
[out]modulepointer to module 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
mxfDeviceModuleAllGet()
mxfDeviceModuleCountGet()
Examples:
ar429_buffer_threshold.cs, ar429_periodic.c, ar429_rx_sampling.cs, canbus_periodic.c, and canbus_sampling.c.
uint32 mxfDeviceModuleAllGet ( HMXF_DEVICE  device,
uint64  type,
uint64  maxCount,
uint64 *  count,
HMXF_MODULE *  modules 
)
C#
public static extern UInt32 mxfDeviceModuleAllGet(UInt64 device, UInt64 type, UInt64 maxCount, out UInt64 count, [Out] UInt64[] modules);

Returns the module handles of the specified type on the device.

Parameters
[in]devicedevice handle
[in]typemodule type
Constant Description
MXF_MODULE_ALL Used to specify any modules.
MXF_MODULE_DIO48 IPM-DIO-48 module
MXF_MODULE_DAC IPM-DAC module
MXF_MODULE_A429E IPM-429 module
MXF_MODULE_DIOFIFO48 IPM-DIO-48-FIFO module
MXF_MODULE_MIL1553MRT IPM-1553-MRT module
MXF_MODULE_ASCBMRT IPM-ASCB module
MXF_MODULE_A629MRT_REV2 IPM-629 module
MXF_MODULE_MULTI IPM-MULTI module
MXF_MODULE_A708 IPM-708 module
MXF_MODULE_ADC IPM-ADC module
MXF_MODULE_DIOFIFO24DIFF IPM-DIO-24 module
MXF_MODULE_ASYNC IPM-ASYNC module
MXF_MODULE_HFCE IPM-HFCE module
MXF_MODULE_CANBUS CAN bus module
MXF_MODULE_MIL1553MRT_EH MIL-1553 Enhanced module
MXF_MODULE_A664 ARINC 664 module
MXF_MODULE_DIOFIFO_EH Discrete input / discrete output Enhanced module
MXF_MODULE_A429_EH ARINC 429 Enhanced module
MXF_MODULE_ASYNC_EH ASYNC 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_FLEXDIO FlexMAX DIO module
MXF_MODULE_FLEXDAC FlexMAX DAC module
MXF_MODULE_FLEXADC FlexMAX ADC module
MXF_MODULE_FLEX429 FlexMAX 429 module
[in]maxCountmaximum number of modules handle that can be returned in modules array
[out]countnumber of modules handle returned
[out]modulesarray of modules 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
mxfDeviceModuleGet()
mxfDeviceModuleCountGet()
Examples:
ar429_aperiodic.cs, ar429_comm_queues.c, ar429_comm_queues.cs, ar429_embedded_bridge.cs, ar429_embedded_comm_queues.c, 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.cs, ar429_rx_acquisition_trigger.cs, ar429_rx_event_handler.cs, 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_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.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, 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.cs, async_tx_error_injection.c, async_tx_error_injection.cs, can_fd.c, canbus.c, canbus.cs, 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, discrete.c, discrete.cs, discrete_Multi.c, discrete_Multi.cs, discrete_pulse_clock.c, discrete_pulse_clock.cs, flexdac.c, flexdio.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.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_bm.c, mil1553_bm.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_embedded.c, mil1553_embedded_update_host.c, mil1553_embedded_update_host.cs, mil1553_errors.c, mil1553_errors.cs, mil1553_manyErrorInjections.c, mil1553_manyErrorInjections.cs, mil1553_rt.c, mil1553_rt.cs, mil1553_rtErrorInjections.c, mil1553_rtErrorInjections.cs, multi.c, multi.cs, usb.c, and usb.cs.
uint32 mxfModuleCountGet ( HMXF_SERVER  server,
uint64  moduleType,
uint64 *  count 
)
C#
public static extern UInt32 mxfModuleCountGet(UInt64 server, UInt64 moduleType, out UInt64 count);

Returns the number of modules detected by MX Foundation.

Parameters
[in]serverserver handle.
[in]moduleTypemodule type
Constant Description
MXF_MODULE_ALL Used to specify any modules.
MXF_MODULE_DIO48 IPM-DIO-48 module
MXF_MODULE_DAC IPM-DAC module
MXF_MODULE_A429E IPM-429 module
MXF_MODULE_DIOFIFO48 IPM-DIO-48-FIFO module
MXF_MODULE_MIL1553MRT IPM-1553-MRT module
MXF_MODULE_ASCBMRT IPM-ASCB module
MXF_MODULE_A629MRT_REV2 IPM-629 module
MXF_MODULE_MULTI IPM-MULTI module
MXF_MODULE_A708 IPM-708 module
MXF_MODULE_ADC IPM-ADC module
MXF_MODULE_DIOFIFO24DIFF IPM-DIO-24 module
MXF_MODULE_ASYNC IPM-ASYNC module
MXF_MODULE_HFCE IPM-HFCE module
MXF_MODULE_CANBUS CAN bus module
MXF_MODULE_MIL1553MRT_EH MIL-1553 Enhanced module
MXF_MODULE_A664 ARINC 664 module
MXF_MODULE_DIOFIFO_EH Discrete input / discrete output Enhanced module
MXF_MODULE_A429_EH ARINC 429 Enhanced module
MXF_MODULE_ASYNC_EH ASYNC 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_FLEXDIO FlexMAX DIO module
MXF_MODULE_FLEXDAC FlexMAX DAC module
MXF_MODULE_FLEXADC FlexMAX ADC module
MXF_MODULE_FLEX429 FlexMAX 429 module
[out]countnumber of modules detected.
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
mxfModuleGet()
mxfModuleAllGet()
uint32 mxfModuleGet ( HMXF_SERVER  server,
uint64  moduleType,
uint64  moduleIndex,
HMXF_MODULE *  module 
)
C#
public static extern UInt32 mxfModuleGet(UInt64 server, UInt64 moduleType, UInt64 moduleIndex, out UInt64 module);

Returns the module handle for the specified module type and index.

Parameters
[in]serverserver handle
[in]moduleTypemodule type
Constant Description
MXF_MODULE_ALL Used to specify any modules.
MXF_MODULE_DIO48 IPM-DIO-48 module
MXF_MODULE_DAC IPM-DAC module
MXF_MODULE_A429E IPM-429 module
MXF_MODULE_DIOFIFO48 IPM-DIO-48-FIFO module
MXF_MODULE_MIL1553MRT IPM-1553-MRT module
MXF_MODULE_ASCBMRT IPM-ASCB module
MXF_MODULE_A629MRT_REV2 IPM-629 module
MXF_MODULE_MULTI IPM-MULTI module
MXF_MODULE_A708 IPM-708 module
MXF_MODULE_ADC IPM-ADC module
MXF_MODULE_DIOFIFO24DIFF IPM-DIO-24 module
MXF_MODULE_ASYNC IPM-ASYNC module
MXF_MODULE_HFCE IPM-HFCE module
MXF_MODULE_CANBUS CAN bus module
MXF_MODULE_MIL1553MRT_EH MIL-1553 Enhanced module
MXF_MODULE_A664 ARINC 664 module
MXF_MODULE_DIOFIFO_EH Discrete input / discrete output Enhanced module
MXF_MODULE_A429_EH ARINC 429 Enhanced module
MXF_MODULE_ASYNC_EH ASYNC 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_FLEXDIO FlexMAX DIO module
MXF_MODULE_FLEXDAC FlexMAX DAC module
MXF_MODULE_FLEXADC FlexMAX ADC module
MXF_MODULE_FLEX429 FlexMAX 429 module
[in]moduleIndexlogical module index (e.g., 0=module 0, 1=module 1, ...)
[out]modulemodule 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
mxfModuleCountGet()
mxfModuleAllGet()
uint32 mxfModuleAllGet ( HMXF_SERVER  server,
uint64  moduleType,
uint64  maxModule,
uint64 *  count,
HMXF_MODULE *  modules 
)
C#
public static extern UInt32 mxfModuleAllGet(UInt64 server, UInt64 moduleType, UInt64 maxModule, out UInt64 count, [Out] UInt64[] modules);

Returns the handle(s) of all modules specified by module type for the server.

Parameters
[in]serverserver handle
[in]moduleTypemodule type
Constant Description
MXF_MODULE_ALL Used to specify any modules.
MXF_MODULE_DIO48 IPM-DIO-48 module
MXF_MODULE_DAC IPM-DAC module
MXF_MODULE_A429E IPM-429 module
MXF_MODULE_DIOFIFO48 IPM-DIO-48-FIFO module
MXF_MODULE_MIL1553MRT IPM-1553-MRT module
MXF_MODULE_ASCBMRT IPM-ASCB module
MXF_MODULE_A629MRT_REV2 IPM-629 module
MXF_MODULE_MULTI IPM-MULTI module
MXF_MODULE_A708 IPM-708 module
MXF_MODULE_ADC IPM-ADC module
MXF_MODULE_DIOFIFO24DIFF IPM-DIO-24 module
MXF_MODULE_ASYNC IPM-ASYNC module
MXF_MODULE_HFCE IPM-HFCE module
MXF_MODULE_CANBUS CAN bus module
MXF_MODULE_MIL1553MRT_EH MIL-1553 Enhanced module
MXF_MODULE_A664 ARINC 664 module
MXF_MODULE_DIOFIFO_EH Discrete input / discrete output Enhanced module
MXF_MODULE_A429_EH ARINC 429 Enhanced module
MXF_MODULE_ASYNC_EH ASYNC 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_FLEXDIO FlexMAX DIO module
MXF_MODULE_FLEXDAC FlexMAX DAC module
MXF_MODULE_FLEXADC FlexMAX ADC module
MXF_MODULE_FLEX429 FlexMAX 429 module
[in]maxModulemaximum number of module handles that can be returned in modules array
[out]countnumber of module handles returned
[out]modulesreturn array of modules handles
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
mxfModuleGet()
mxfModuleCountGet()
Updated 03/30/2022