Firmware File & Version

Functions
uint32	mxfSystemVersionGet (HMXF_SERVER server, uint64 *major, uint64 *minor, uint64 *subMinor)
uint32	mxfClientVersion (uint64 *major, uint64 *minor, uint64 *subMinor)
uint32	mxfDeviceFileVersionGet (HMXF_SERVER server, uint64 index, uint64 type, uint64 *major, uint64 *minor, uint64 *subMinor)
uint32	mxfDeviceFileVersionWantedGet (HMXF_SERVER server, uint64 index, uint64 type, uint64 *major, uint64 *minor, uint64 *subMinor)

Detailed Description

Function Documentation

uint32 mxfSystemVersionGet	(	HMXF_SERVER	server,
		uint64 *	major,
		uint64 *	minor,
		uint64 *	subMinor
	)

C#

public static extern UInt32 mxfSystemVersionGet(UInt64 server, out UInt64 major, out UInt64 minor, out UInt64 subminor);

Returns MX Foundation library version. This function can be called before the initialization of MX Foundation.

Parameters

[in]	server	server handle. It is possible to get the version locally installed without connecting first to the local server by passing 0 as server parameter.
[out]	major	library major version number
[out]	minor	library minor version number
[out]	subMinor	library sub minor version number

example: If major is 4, minor is 1 and subMinor is 12, MX Foundation 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()

mxfClientVersion()

uint32 mxfClientVersion	(	uint64 *	major,
		uint64 *	minor,
		uint64 *	subMinor
	)

C#

public static extern UInt32 mxfClientVersion(out UInt64 major, out UInt64 minor, out UInt64 subminor);

Returns local MX Foundation library version.

Parameters

[out]	major	library major version number
[out]	minor	library minor version number
[out]	subMinor	library sub minor version number

example: If major is 4, minor is 1 and subMinor is 12, MX Foundation 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()

mxfSystemVersionGet()

uint32 mxfDeviceFileVersionGet	(	HMXF_SERVER	server,
		uint64	index,
		uint64	type,
		uint64 *	major,
		uint64 *	minor,
		uint64 *	subMinor
	)

C#

public static extern UInt32 mxfDeviceFileVersionGet(UInt64 server, UInt64 index, UInt64 type, out UInt64 major, out UInt64 minor, out UInt64 subminor);

Returns the current file version running on the specified device. Useful when mxfSystemInit() or mxfSystemResourcesInit() function returns MAXT_ERROR_WRONG_FIRMWARE or MAXT_ERROR_WRONG_BOOT.

Parameters

[in]	server	server handle
[in]	index	device index
[in]	type	type of the device file Constant Description MXF_DEVICE_FILE_BOOT Specify the boot file MXF_DEVICE_FILE_MXFCORE Specify the MXF firmware MXF_DEVICE_FIRMWARE_PKG_VERSION Specify the MXF package version
[out]	major	major version number returned
[out]	minor	minor version number returned
[out]	subMinor	sub minor version number returned

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

mxfDeviceFileVersionWantedGet()

uint32 mxfDeviceFileVersionWantedGet	(	HMXF_SERVER	server,
		uint64	index,
		uint64	type,
		uint64 *	major,
		uint64 *	minor,
		uint64 *	subMinor
	)

C#

public static extern UInt32 mxfDeviceFileVersionWantedGet(UInt64 server, UInt64 index, UInt64 type, out UInt64 major, out UInt64 minor, out UInt64 subminor);

Returns the required file version running on the specified device. Useful when mxfSystemInit() or mxfSystemResourcesInit() function returns MAXT_ERROR_WRONG_FIRMWARE or MAXT_ERROR_WRONG_BOOT.

Parameters

[in]	server	server handle
[in]	index	device index
[in]	type	type of device file Constant Description MXF_DEVICE_FILE_BOOT Specify the boot file MXF_DEVICE_FILE_MXFCORE Specify the MXF firmware
[out]	major	major version number returned
[out]	minor	minor version number returned
[out]	subMinor	sub minor version number returned

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()

mxfDeviceFileVersionGet()