MX Foundation 4

Functions

uint32 mxfEmbeddedCommandSend (HMXF_DEVICE device, uint64 command, uint64 paramSize, uint32 *param)
 

Detailed Description

Function Documentation

uint32 mxfEmbeddedCommandSend ( HMXF_DEVICE  device,
uint64  command,
uint64  paramSize,
uint32 *  param 
)
C#
public static extern UInt32 mxfEmbeddedCommandSend(UInt64 device, UInt64 command, UInt64 paramSize, UInt32[] param);

Sends a command to the embedded code that was previously loaded on the specified device using the mxfEmbeddedCodeDownload(). The parameter buffer lets the user sends several parameters along with the command.

Parameters
[in]devicedevice handle
[in]commandcommand IDs.entifier.
[in]paramSizenumber of 32-bit word to send. 64 32-bit word maximum.
[in]paramparameters buffer pointer or NULL. 64 32-bit word maximum.

The data in the buffer is copied using 32-bit access. To avoid any endianness mapping issues, it is recommended to use only 32-bit data format for this 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
mxfSystemDeviceGet()
mxfSystemDeviceAllGet()
mxfSystemInitAttributeUint64CallbackHandler()
mxfEmbeddedCodeDownload()
Examples:
ar429_embedded_discrete.c, ar429_embedded_discrete.cs, ar429_embedded_timer.c, and ar429_embedded_timer.cs.
Updated 10/23/2023