MX Foundation 4

Functions

uint32 mxfServerConnect (const char *url, const char *userName, const char *password, uint64 exclusive, HMXF_SERVER *server)
 
uint32 mxfServerDisconnect (HMXF_SERVER server)
 
uint32 mxfServerVersionGet (HMXF_SERVER server, uint64 *major, uint64 *minor, uint64 *subMinor)
 
uint32 mxfServerUserCountGet (HMXF_SERVER server, uint64 *count)
 
uint32 mxfServerUserListGet (HMXF_SERVER server, uint64 maxCount, uint64 *count, MXF_NETWORK_SERVER_USER_INFO *users)
 
uint32 mxfServerUserDisconnect (HMXF_SERVER server, uint64 id)
 
uint32 mxfServerACLUserCountGet (HMXF_SERVER server, uint64 *count)
 
uint32 mxfServerACLUserListGet (HMXF_SERVER server, uint64 maxCount, uint64 *count, MXF_ACL_USER *users)
 
uint32 mxfServerACLUserGet (HMXF_SERVER server, MXF_ACL_USER *user)
 
uint32 mxfServerACLUserSet (HMXF_SERVER server, MXF_ACL_USER *user)
 
uint32 mxfServerACLUserRemove (HMXF_SERVER server, MXF_ACL_USER *user)
 
uint32 mxfServerACLUserAdd (HMXF_SERVER server, MXF_ACL_USER *user)
 
uint32 mxfServerACLUserPortAssignmentSet (HMXF_SERVER server, const char *username, uint64 count, HMXF_CHANNEL *channels)
 
uint32 mxfServerACLUserPortAssignmentGet (HMXF_SERVER server, const char *username, uint64 maxCount, uint64 *count, HMXF_CHANNEL *channels)
 
uint32 mxfServerACLUserWriteToFlash (HMXF_SERVER server)
 

Detailed Description

Function Documentation

uint32 mxfServerConnect ( const char *  url,
const char *  userName,
const char *  password,
uint64  exclusive,
HMXF_SERVER *  server 
)
C#
public static extern UInt32 mxfServerConnect(string url, string username, string password, UInt64 exclusive, out UInt64 server);

Connects to MX Foundation's server (local or Ethernet).

An Ethernet client can have a maximum of 64 open connections to Ethernet servers.

Parameters
[in]urlurl or IPv4 network address in dot-decimal notation. For local connection, use 0.0.0.0 as url.
[in]userNameuser name. For local connection, user name must be an empty string.
[in]passwordpassword. For local connection, password must be an empty string.
[in]exclusivespecify if exclusive control of the server is required. For local connection, exclusive must be false.
[out]serverserver handle returned
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.
See Client/Server chapter for more information about connection and server configuration.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfServerVersionGet()
mxfServerDisconnect()
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_comm_queues.c, ar429_comm_queues.cs, ar429_embedded_bridge.c, 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.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, canbus.c, canbus.cs, canbus_periodic.c, canbus_sampling.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, device_info.c, device_info.cs, discrete.c, discrete.cs, discrete_event_handler.c, discrete_event_handler.cs, discrete_fifo.c, discrete_fifo.cs, discrete_Multi.c, discrete_Multi.cs, discrete_pulse_clock.c, discrete_pulse_clock.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.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.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_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_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_rt_rt.c, mil1553_rt_rt.cs, mil1553_rtErrorInjections.c, mil1553_rtErrorInjections.cs, multi.c, multi.cs, pulse.c, selfTests.c, selfTests.cs, write_read_async.c, and write_read_async.cs.
uint32 mxfServerDisconnect ( HMXF_SERVER  server)
C#
public static extern UInt32 mxfServerDisconnect(UInt64 server);

Disconnects a client application from a MX Foundation's server.

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()
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_comm_queues.c, ar429_comm_queues.cs, ar429_embedded_bridge.c, 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.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, canbus.c, canbus.cs, canbus_periodic.c, canbus_sampling.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, device_info.c, device_info.cs, discrete.c, discrete.cs, discrete_event_handler.c, discrete_event_handler.cs, discrete_fifo.c, discrete_fifo.cs, discrete_Multi.c, discrete_Multi.cs, discrete_pulse_clock.c, discrete_pulse_clock.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.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.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_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_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_rt_rt.c, mil1553_rt_rt.cs, mil1553_rtErrorInjections.c, mil1553_rtErrorInjections.cs, multi.c, multi.cs, pulse.c, selfTests.c, selfTests.cs, usb.c, usb.cs, write_read_async.c, and write_read_async.cs.
uint32 mxfServerVersionGet ( HMXF_SERVER  server,
uint64 *  major,
uint64 *  minor,
uint64 *  subMinor 
)
C#
public static extern UInt32 mxfServerVersionGet(UInt64 server, out UInt64 major, out UInt64 minor, out UInt64 subminor);

Returns the version of the remote server. To get the version of the local server (server running on the system), you have to connect to it (for example, by connecting to ip address 127.0.0.1). When connected locally (with ip address 0.0.0.0), this function is not available, no server is in fact used in this case.

Parameters
[in]serverserver handle
[out]majormajor version
[out]minorminor version
[out]subMinorsub minor version

example: If major is 4, minor is 1 and subMinor is 12, version is 4.1.12

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()
uint32 mxfServerUserCountGet ( HMXF_SERVER  server,
uint64 *  count 
)
C#
public static extern UInt32 mxfServerUserCountGet(UInt64 server, out UInt64 count);

Returns the number of users connected to a MX Foundation's server. Admin privileges is required to use this function.

Parameters
[in]serverserver handle
[out]countnumber of users connected to the server
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()
uint32 mxfServerUserListGet ( HMXF_SERVER  server,
uint64  maxCount,
uint64 *  count,
MXF_NETWORK_SERVER_USER_INFO users 
)
C#
public static extern UInt32 mxfServerUserListGet(UInt64 server, UInt64 maxCount, out UInt64 count, [Out] MXF_NETWORK_SERVER_USER_INFO[] users);

Returns the list of users connected to a MX Foundation's server. Admin privileges is required to use this function.

Parameters
[in]serverserver handle
[in]maxCountmaximum number of users entries to return
[out]countnumber of users entries returned
[out]userspointer to the MXF_NETWORK_SERVER_USER_INFO 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
mxfServerConnect()
uint32 mxfServerUserDisconnect ( HMXF_SERVER  server,
uint64  id 
)
C#
public static extern UInt32 mxfServerUserDisconnect(UInt64 server, UInt64 id);

Disconnects the specified user from the MX Foundation's server. Admin privileges is required to use this function.

Parameters
[in]serverserver handle
[in]iduser 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
mxfServerConnect()
uint32 mxfServerACLUserCountGet ( HMXF_SERVER  server,
uint64 *  count 
)
C#
public static extern UInt32 mxfServerACLUserCountGet(UInt64 server, out UInt64 count);

Returns the number of users in server configuration file. Admin privileges is required to use this function.

Parameters
[in]serverserver handle
[out]countnumber of users
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
mxfServerACLUserListGet()
uint32 mxfServerACLUserListGet ( HMXF_SERVER  server,
uint64  maxCount,
uint64 *  count,
MXF_ACL_USER users 
)
C#
public static extern UInt32 mxfServerACLUserListGet(UInt64 server, UInt64 maxCount, out UInt64 count, [Out] MXF_ACL_USER[] users);

Returns the list of entries in server configuration file. Admin privileges is required to use this function.

Parameters
[in]serverserver handle
[in]maxCountmaximum number of entries to return
[out]countnumber of entries returned
[out]usersentries returned
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
mxfServerACLUserCountGet()
mxfServerACLUserGet()
uint32 mxfServerACLUserGet ( HMXF_SERVER  server,
MXF_ACL_USER user 
)
C#
public static extern UInt32 mxfServerACLUserGet(UInt64 server, ref MXF_ACL_USER user);

Finds the user in the list of entries of server configuration file. Admin privileges is required to use this function.

Parameters
[in]serverserver handle
[in,out]useruser to find. username must be set to the user name to find.
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
mxfServerACLUserListGet()
mxfServerACLUserSet()
mxfServerACLUserRemove()
uint32 mxfServerACLUserSet ( HMXF_SERVER  server,
MXF_ACL_USER user 
)
C#
public static extern UInt32 mxfServerACLUserSet(UInt64 server, MXF_ACL_USER user);

Changes the parameters for the user in the list of entries of server configuration file. Admin privileges is required to use this function. The username must already be present in the list of entries.

Parameters
[in]serverserver handle
[in]useruser to change. mxfServerACLUserWriteToFlash() must be called to save the file in flash.
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
mxfServerACLUserAdd()
mxfServerACLUserWriteToFlash()
uint32 mxfServerACLUserRemove ( HMXF_SERVER  server,
MXF_ACL_USER user 
)
C#
public static extern UInt32 mxfServerACLUserRemove(UInt64 server, ref MXF_ACL_USER user);

Removes the user from the list of entries of server configuration file. Admin privileges is required to use this function.

Parameters
[in]serverserver handle
[in,out]useruser to remove. username must be set to the user name to remove. mxfServerACLUserWriteToFlash() must be called to save the file in flash.
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
mxfServerACLUserWriteToFlash()
mxfServerACLUserGet()
mxfServerACLUserAdd()
uint32 mxfServerACLUserAdd ( HMXF_SERVER  server,
MXF_ACL_USER user 
)
C#
public static extern UInt32 mxfServerACLUserAdd(UInt64 server, ref MXF_ACL_USER user);

Adds the user from the list of entries of server configuration file. Admin privileges is required to use this function.

Parameters
[in]serverserver handle
[in,out]useruser to add. username must be set to the user name to add. mxfServerACLUserWriteToFlash() must be called to save the file in flash.
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
mxfServerACLUserWriteToFlash()
mxfServerACLUserSet()
mxfServerACLUserRemove()
uint32 mxfServerACLUserPortAssignmentSet ( HMXF_SERVER  server,
const char *  username,
uint64  count,
HMXF_CHANNEL *  channels 
)
C#
public static extern UInt32 mxfServerACLUserPortAssignmentSet(UInt64 server, string username, UInt64 count, UInt64[] channels);

Sets the list of channels a user should use. Admin privileges is required to use this function. When set, mxfServerACLUserWriteToFlash() must be called to save the list in flash.

Parameters
[in]serverserver handle
[in]usernameusername associated with this list
[in]countnumber of channels in channel list
[in]channelslist of channel handles to associate to this user
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
mxfServerACLUserPortAssignmentGet()
mxfServerACLUserWriteToFlash()
uint32 mxfServerACLUserPortAssignmentGet ( HMXF_SERVER  server,
const char *  username,
uint64  maxCount,
uint64 *  count,
HMXF_CHANNEL *  channels 
)
C#
public static extern UInt32 mxfServerACLUserPortAssignmentGet(UInt64 server, string username, UInt64 maxCount, out UInt64 count, [Out] UInt64[] channels);

Gets the list of channels a user should use.

Parameters
[in]serverserver handle
[in]usernameusername associated with this list
[in]maxCountmaximum number of channels to return
[out]countnumber of channels in channel list
[out]channelslist of channel handles associated to this user
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
mxfServerACLUserPortAssignmentSet()
uint32 mxfServerACLUserWriteToFlash ( HMXF_SERVER  server)
C#
public static extern UInt32 mxfServerACLUserWriteToFlash(UInt64 server);

Writes the modification to server configuration file to nor-flash. Admin privileges is required to use this function.

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
mxfServerACLUserAdd()
mxfServerACLUserRemove()
Updated 03/30/2022