Functions
uint32	mxfEmbeddedNVStorageHandleGet (HMXF_DEVICE device, HMXF_NVSTORAGE *nvStorage)

uint32	mxfEmbeddedNVStorageFormat (HMXF_NVSTORAGE nvStorage)

uint32	mxfEmbeddedNVStorageLocationGet (HMXF_NVSTORAGE nvStorage, uint64 *index)

uint32	mxfEmbeddedNVStorageInfoGet (HMXF_NVSTORAGE nvStorage, MXF_NVSTORAGE_INFO *info)

uint32	mxfEmbeddedNVStorageMount (HMXF_NVSTORAGE nvStorage)

uint32	mxfEmbeddedNVStorageUmount (HMXF_NVSTORAGE nvStorage)

uint32	mxfEmbeddedNVStorageFSCheck (HMXF_NVSTORAGE nvStorage)

uint32	mxfEmbeddedNVStorageFileCreate (HMXF_NVSTORAGE nvStorage, uint64 count, uint64 *index)

uint32	mxfEmbeddedNVStorageFileCountGet (HMXF_NVSTORAGE nvStorage, uint64 *count)

uint32	mxfEmbeddedNVStorageFileSizeGet (HMXF_NVSTORAGE nvStorage, uint64 index, uint64 *size)

uint32	mxfEmbeddedNVStorageFileReset (HMXF_NVSTORAGE nvStorage, uint64 index)

uint32	mxfEmbeddedNVStorageFileRewind (HMXF_NVSTORAGE nvStorage, uint64 index)

uint32	mxfEmbeddedNVStorageFileMsgTypeSet (HMXF_NVSTORAGE nvStorage, uint64 index, uint64 type)

uint32	mxfEmbeddedNVStorageFileMsgTypeGet (HMXF_NVSTORAGE nvStorage, uint64 index, uint64 *type)

uint32	mxfEmbeddedNVStorageFileMsgSelectEnableSet (HMXF_CHANNEL channel, uint64 index, uint64 options, uint64 enable)

uint32	mxfEmbeddedNVStorageFileMsgSelectEnableGet (HMXF_CHANNEL channel, uint64 index, uint64 options, uint64 *enable)

uint32	mxfEmbeddedNVStorageFileMsgSelectSet (HMXF_CHANNEL channel, uint64 select, uint64 count, void *msg)

uint32	mxfEmbeddedNVStorageFileMsgSelectGet (HMXF_CHANNEL channel, uint64 maxCount, uint64 count, void msg)

uint32	mxfEmbeddedNVStorageFileMsgRead (HMXF_NVSTORAGE nvStorage, uint64 index, uint64 maxMsgCount, uint64 maxBytesCount, uint64 msgCount, uint64 byteCount, void *msg)

uint32	mxfRawEmbeddedNVStorageFileMsgRead (HMXF_NVSTORAGE nvStorage, uint64 index, uint64 maxMsgCount, uint64 maxBytesCount, uint64 msgCount, uint64 byteCount, uint8 *msg)

uint32	mxfUserDefEmbeddedNVStorageFileMsgRead (HMXF_NVSTORAGE nvStorage, uint64 index, uint64 maxMsgCount, uint64 maxBytesCount, uint64 msgCount, uint64 byteCount, MXF_EMBEDDED_DATAREC *msg)

uint32	mxfEmbeddedNVStorageFileStatusGet (HMXF_NVSTORAGE nvStorage, uint64 index, uint64 freeByte, uint64 unreadByte, uint64 bufferedWriteByte, uint64 overflow)

uint32	mxfEmbeddedNVStorageFileMsgWrite (HMXF_NVSTORAGE nvStorage, uint64 index, uint64 maxCount, void msg, uint64 count)

uint32	mxfRawEmbeddedNVStorageFileMsgWrite (HMXF_NVSTORAGE nvStorage, uint64 index, uint64 maxCount, uint8 rec, uint64 count)

uint32	mxfUserDefEmbeddedNVStorageFileMsgWrite (HMXF_NVSTORAGE nvStorage, uint64 index, uint64 maxCount, MXF_EMBEDDED_DATAREC rec, uint64 count)

Detailed Description

Function Documentation

uint32 mxfEmbeddedNVStorageHandleGet	(	HMXF_DEVICE	device,
		HMXF_NVSTORAGE *	nvStorage
	)

C#: public static extern UInt32 mxfEmbeddedNVStorageHandleGet(UInt64 device, out UInt64 nvStorage);

Returns the handle of the non-volatile storage for the specific device.

Parameters

[in]	device	device handle
[out]	nvStorage	non-volatile storage 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: mxfSystemDeviceGet(); mxfSystemDeviceAllGet()

Examples:: ar429_embedded_recorder.c, ar429_embedded_recorder.cs, ar717_embedded_recorder.c, and ar717_embedded_recorder.cs.

uint32 mxfEmbeddedNVStorageFormat ( HMXF_NVSTORAGE nvStorage )

C#: public static extern UInt32 mxfEmbeddedNVStorageFormat(UInt64 nvStorage);

Formats the non-volatile storage device.

Parameters

[in] nvStorage non-volatile storage 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: mxfEmbeddedNVStorageHandleGet()

Examples:: ar429_embedded_recorder.c, ar429_embedded_recorder.cs, ar717_embedded_recorder.c, and ar717_embedded_recorder.cs.

uint32 mxfEmbeddedNVStorageLocationGet	(	HMXF_NVSTORAGE	nvStorage,
		uint64 *	index
	)

C#: public static extern UInt32 mxfEmbeddedNVStorageLocationGet(UInt64 nvStorage, out UInt64 index);

Returns the location of a specific non-volatile storage device.

Parameters

[in]	nvStorage	non-volatile storage handle
[out]	index	device index where the non-volatile storage device is located

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

uint32 mxfEmbeddedNVStorageInfoGet	(	HMXF_NVSTORAGE	nvStorage,
		MXF_NVSTORAGE_INFO *	info
	)

C#: public static extern UInt32 mxfEmbeddedNVStorageInfoGet(UInt64 nvStorage, out MXF_NVSTORAGE_INFO info);

Returns the non-volatile storage information.

Parameters

[in]	nvStorage	non-volatile storage handle
[out]	info	pointer to MXF_NVSTORAGE_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: mxfEmbeddedNVStorageHandleGet()

Examples:: ar429_embedded_recorder.c, ar429_embedded_recorder.cs, ar717_embedded_recorder.c, and ar717_embedded_recorder.cs.

uint32 mxfEmbeddedNVStorageMount ( HMXF_NVSTORAGE nvStorage )

C#: public static extern UInt32 mxfEmbeddedNVStorageMount(UInt64 nvStorage);

Mounts the non-volatile storage. This function must be called before accessing files with eMMC type. Use mxfEmbeddedNVStorageInfoGet() to get non-volatile storage type. When done with accessing non-volatile storage, unmount it with mxfEmbeddedNVStorageUmount(). If the device is reset without properly unmounting the non-volatile storage, a file system check might be necessary with mxfEmbeddedNVStorageFSCheck() to be able to mount it again.

Parameters

[in] nvStorage non-volatile storage 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.1 and later.

See also: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageInfoGet(); mxfEmbeddedNVStorageUmount(); mxfEmbeddedNVStorageFSCheck()

Examples:: ar429_embedded_recorder.c, ar429_embedded_recorder.cs, ar717_embedded_recorder.c, and ar717_embedded_recorder.cs.

uint32 mxfEmbeddedNVStorageUmount ( HMXF_NVSTORAGE nvStorage )

C#: public static extern UInt32 mxfEmbeddedNVStorageUmount(UInt64 nvStorage);

Umounts the non-volatile storage. This function must be called when done accessing files with eMMC type. Use mxfEmbeddedNVStorageInfoGet() to get non-volatile storage type. If the device is reset without properly unmounting the non-volatile storage, a file system check might be necessary with mxfEmbeddedNVStorageFSCheck() to be able to mount it again.

Parameters

[in] nvStorage non-volatile storage 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.1 and later.

See also: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageInfoGet(); mxfEmbeddedNVStorageMount(); mxfEmbeddedNVStorageFSCheck()

Examples:: ar429_embedded_recorder.c, ar429_embedded_recorder.cs, ar717_embedded_recorder.c, and ar717_embedded_recorder.cs.

uint32 mxfEmbeddedNVStorageFSCheck ( HMXF_NVSTORAGE nvStorage )

C#: public static extern UInt32 mxfEmbeddedNVStorageFSCheck(UInt64 nvStorage);

Checks the non-volatile storage file system integrity. If the device is reset without properly unmounting the non-volatile storage, a file system check might be necessary with this function to be able to mount it again.

Parameters

[in] nvStorage non-volatile storage 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.1 and later.

See also: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageInfoGet(); mxfEmbeddedNVStorageMount(); mxfEmbeddedNVStorageUmount()

uint32 mxfEmbeddedNVStorageFileCreate	(	HMXF_NVSTORAGE	nvStorage,
		uint64	count,
		uint64 *	index
	)

C#: public static extern UInt32 mxfEmbeddedNVStorageFileCreate(UInt64 nvStorage, UInt64 count, out UInt64 index);

Creates a file of the specified size on the specified flash.

Parameters

[in]	nvStorage	non-volatile storage handle
[in]	count	number of sectors to allocate. The size of a sector is returned by mxfEmbeddedNVStorageInfoGet() function
[out]	index	returned index of file created referenced by other function call

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: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageInfoGet()

Examples:: ar429_embedded_recorder.c, ar429_embedded_recorder.cs, ar717_embedded_recorder.c, and ar717_embedded_recorder.cs.

uint32 mxfEmbeddedNVStorageFileCountGet	(	HMXF_NVSTORAGE	nvStorage,
		uint64 *	count
	)

C#: public static extern UInt32 mxfEmbeddedNVStorageFileCountGet(UInt64 nvStorage, out UInt64 count);

Returns the number of file allocated on the specified non-volatile storage device.

Parameters

[in]	nvStorage	non-volatile storage handle
[out]	count	number of files currently allocated.

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: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileCreate()

Examples:: ar429_embedded_recorder.c, ar429_embedded_recorder.cs, ar717_embedded_recorder.c, and ar717_embedded_recorder.cs.

uint32 mxfEmbeddedNVStorageFileSizeGet	(	HMXF_NVSTORAGE	nvStorage,
		uint64	index,
		uint64 *	size
	)

C#: public static extern UInt32 mxfEmbeddedNVStorageFileSizeGet(UInt64 nvStorage, UInt64 index, out UInt64 size);

Returns the size in sector of the specified file index.

Parameters

[in]	nvStorage	non-volatile storage handle
[in]	index	file index of the file
[out]	size	returned size in sectors of the allocated file. The size of a sector is returned by mxfEmbeddedNVStorageInfoGet() 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: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileCreate(); mxfEmbeddedNVStorageInfoGet()

Examples:: ar429_embedded_recorder.c, ar429_embedded_recorder.cs, ar717_embedded_recorder.c, and ar717_embedded_recorder.cs.

uint32 mxfEmbeddedNVStorageFileReset	(	HMXF_NVSTORAGE	nvStorage,
		uint64	index
	)

C#: public static extern UInt32 mxfEmbeddedNVStorageFileReset(UInt64 nvStorage, UInt64 index);

Resets the read/write pointer to the beginning of the file. The file is then virtually empty.

Parameters

[in]	nvStorage	non-volatile storage handle
[in]	index	file index of the file

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: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileCreate(); mxfEmbeddedNVStorageFileRewind()

Examples:: ar429_embedded_recorder.c, ar429_embedded_recorder.cs, ar717_embedded_recorder.c, and ar717_embedded_recorder.cs.

uint32 mxfEmbeddedNVStorageFileRewind	(	HMXF_NVSTORAGE	nvStorage,
		uint64	index
	)

C#: public static extern UInt32 mxfEmbeddedNVStorageFileRewind(UInt64 nvStorage, UInt64 index);

Resets the read pointer to the beginning of the file. Write operation will continue to append messages at the end of the file.

Parameters

[in]	nvStorage	non-volatile storage handle
[in]	index	file index of the file

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: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileCreate(); mxfEmbeddedNVStorageFileReset()

uint32 mxfEmbeddedNVStorageFileMsgTypeSet	(	HMXF_NVSTORAGE	nvStorage,
		uint64	index,
		uint64	type
	)

C#: public static extern UInt32 mxfEmbeddedNVStorageFileMsgTypeSet(UInt64 nvStorage, UInt64 index, UInt64 type);

Sets the message type of the specified file index.

The message type is automatically known when the recording of the message selection is enabled with mxfEmbeddedNVStorageFileMsgSelectEnableSet().

This function is useful in the case the user wants to write in the file with the raw format or user defined structure.

Parameters

[in] nvStorage non-volatile storage handle

[in] index file index of the file

[in]

type

file type attribute to set.

Type ID	Description
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_RAW_SECTOR	Read and write are performed by sector. Use mxfEmbeddedNVStorageInfoGet() function to get the sector size.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A429	Read and write are formatted according to MXF_DATAREC_A429 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_CSDB	Read and write are formatted according to MXF_DATAREC_CSDB structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_DISCRETE	Read and write are formatted according to MXF_DATAREC_DISCRETE structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_MIL1553	Read and write are formatted according to MXF_DATAREC_MIL1553 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_ASYNC_ENHANCED	Read and write are formatted according to MXF_DATAREC_ASYNC_EH structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A629	Read and write are formatted according to MXF_DATAREC_A629 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A717	Read and write are formatted according to MXF_DATAREC_A717 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A708	Read and write are formatted according to MXF_DATAREC_A708 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_HDLC	Read and write are formatted according to MXF_DATAREC_HDLC structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_USERDEF	Read and write are formatted according to MXF_DATAREC_EMBEDDED structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_CANBUS	Read and write are formatted according to MXF_DATAREC_CANBUS structure.

Note: The file needs to be empty before calling this 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: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileCreate(); mxfEmbeddedNVStorageFileMsgTypeGet(); mxfEmbeddedNVStorageFileRewind()

uint32 mxfEmbeddedNVStorageFileMsgTypeGet	(	HMXF_NVSTORAGE	nvStorage,
		uint64	index,
		uint64 *	type
	)

C#: public static extern UInt32 mxfEmbeddedNVStorageFileMsgTypeGet(UInt64 nvStorage, UInt64 index, out UInt64 type);

Returns the message type associated to the specified file.

Parameters

[in] nvStorage non-volatile storage handle

[in] index file index of the file

[out]

type

file type

Type ID	Description
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_RAW_SECTOR	Read and write are performed by sector. Use mxfEmbeddedNVStorageInfoGet() function to get the sector size.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A429	Read and write are formatted according to MXF_DATAREC_A429 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_CSDB	Read and write are formatted according to MXF_DATAREC_CSDB structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_DISCRETE	Read and write are formatted according to MXF_DATAREC_DISCRETE structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_MIL1553	Read and write are formatted according to MXF_DATAREC_MIL1553 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_ASYNC_ENHANCED	Read and write are formatted according to MXF_DATAREC_ASYNCEH structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A629	Read and write are formatted according to MXF_DATAREC_A629 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A717	Read and write are formatted according to MXF_DATAREC_A717 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A708	Read and write are formatted according to MXF_DATAREC_A708 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_HDLC	Read and write are formatted according to MXF_DATAREC_HDLC structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_USERDEF	Read and write are formatted according to MXF_DATAREC_EMBEDDED structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_CANBUS	Read and write are formatted according to MXF_DATAREC_CANBUS 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: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileCreate(); mxfEmbeddedNVStorageFileMsgTypeSet()

uint32 mxfEmbeddedNVStorageFileMsgSelectEnableSet	(	HMXF_CHANNEL	channel,
		uint64	index,
		uint64	options,
		uint64	enable
	)

C#: public static extern UInt32 mxfEmbeddedNVStorageFileMsgSelectEnableSet(UInt64 channel, UInt64 index, UInt64 options, UInt64 enable);

Enables the automatic recording of messages in a file when a record is received on an RX channel.

Note: If record selection (filtering) is needed for the port, mxfEmbeddedNVStorageFileMsgSelectSet() function should be called previously.

Parameters

[in] channel channel handle

[in] index file index of the file. Must be set to 0 when calling enable with VMXF_DISABLE.

[in] options reserved for future use. Must be set to 0.

[in]

enable

action to perform:

Constant	Description
VMXF_ENABLE	Enables recording
VMXF_DISABLE	Disables recording

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: mxfModuleChannelAllGet(); mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileCreate(); mxfEmbeddedNVStorageFileMsgSelectSet()

Examples:: ar429_embedded_recorder.c, ar429_embedded_recorder.cs, ar717_embedded_recorder.c, and ar717_embedded_recorder.cs.

uint32 mxfEmbeddedNVStorageFileMsgSelectEnableGet	(	HMXF_CHANNEL	channel,
		uint64 *	index,
		uint64 *	options,
		uint64 *	enable
	)

C#: public static extern UInt32 mxfEmbeddedNVStorageFileMsgSelectEnableGet(UInt64 channel, out UInt64 index, out UInt64 options, out UInt64 enable);

Gets the state of the automatic recording of messages.

Parameters

[in] channel channel handle.

[out] index file index of the file

[out] options reserved for future use. Must be set to 0.

[out]

enable

automatic recording state

Constant	Description
VMXF_ENABLE	Recording enabled
VMXF_DISABLE	Recording 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: mxfModuleChannelAllGet(); mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileCreate(); mxfEmbeddedNVStorageFileMsgSelectSet()

uint32 mxfEmbeddedNVStorageFileMsgSelectSet	(	HMXF_CHANNEL	channel,
		uint64	select,
		uint64	count,
		void *	msg
	)

Selects / deselects the specified message IDs on a channel for automatic embedded non-volatile storage recording.

Note: This function should be called before the function mxfEmbeddedNVStorageFileMsgSelectEnableSet() that starts the logging of messages on file for the specific channel.; count set to 0 with a msg set to NULL means ALL message IDs.

Parameters

[in] channel channel handle

[in]

select

action to perform with the provided selection list

Action	Description
MXF_MSG_DESELECT	Deselects the messages
MXF_MSG_SELECT_ADD	Adds the specified messages
MXF_MSG_SELECT_ONLY	Replaces the current selection with the provided list

[in] count count of messages

[in]

msg

pointer to an array of message identifiers.

Channel class	Message identifier structure
ARINC 429	MXF_MSGID_A429
MIL-STD-1553	MXF_MSGID_MIL1553
CSDB	MXF_MSGID_CSDB
ARINC 629	MXF_MSGID_A629
ARINC 708	MXF_MSGID_A708
CAN	MXF_MSGID_CANBUS

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: mxfModuleChannelAllGet(); mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileMsgSelectEnableSet(); mxfEmbeddedNVStorageFileMsgSelectGet()

uint32 mxfEmbeddedNVStorageFileMsgSelectGet	(	HMXF_CHANNEL	channel,
		uint64	maxCount,
		uint64 *	count,
		void *	msg
	)

Returns the specific message IDs registered on a channel for automatic embedded non-volatile storage recording.

Parameters

[in] channel channel handle.

[in] maxCount maximum count of messages return in the array

[out] count count of messages returned

[out]

msg

pointer to an array of message identifiers.

Channel class	Message identifier structure
ARINC 429	MXF_MSGID_A429
MIL-STD-1553	MXF_MSGID_MIL1553
CSDB	MXF_MSGID_CSDB
ARINC 629	MXF_MSGID_A629
ARINC 708	MXF_MSGID_A708
CAN	MXF_MSGID_CANBUS

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: mxfModuleChannelAllGet(); mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileMsgSelectSet(); mxfEmbeddedNVStorageFileMsgSelectEnableSet()

uint32 mxfEmbeddedNVStorageFileMsgRead	(	HMXF_NVSTORAGE	nvStorage,
		uint64	index,
		uint64	maxMsgCount,
		uint64	maxBytesCount,
		uint64 *	msgCount,
		uint64 *	byteCount,
		void *	msg
	)

Reads the records from a specific file. The messages format will follow the message type of the file.

Parameters

[in] nvStorage non-volatile storage handle

[in] index file index

[in] maxMsgCount maximum number of messages that can be returned

[in] maxBytesCount maximum byte count that can be returned

[out] msgCount count of messages returned

[out] byteCount number of bytes returned in the msg buffer

[out]

msg

pointer to read buffer containing messages. The record format depends on the type of the file. The records in the buffer need to be indexed using the mxfNextRecordPtrGet() function.

Type ID	Description
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_RAW_SECTOR	Records are formatted by sector. Use mxfEmbeddedNVStorageInfoGet() function to get the sector size.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A429	Records are formatted according to MXF_DATAREC_A429 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_CSDB	Records are formatted according to MXF_DATAREC_CSDB structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_DISCRETE	Records are formatted according to MXF_DATAREC_DISCRETE structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_MIL1553	Records are formatted according to MXF_DATAREC_MIL1553 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_ASYNC_ENHANCED	Records are formatted according to MXF_DATAREC_ASYNCEH structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A629	Records are formatted according to MXF_DATAREC_A629 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A717	Records are formatted according to MXF_DATAREC_A717 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A708	Records are formatted according to MXF_DATAREC_A708 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_HDLC	Records are formatted according to MXF_DATAREC_HDLC structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_USERDEF	Records are formatted according to MXF_DATAREC_EMBEDDED structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_CANBUS	Read and write are formatted according to MXF_DATAREC_CANBUS 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: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileStatusGet()

uint32 mxfRawEmbeddedNVStorageFileMsgRead	(	HMXF_NVSTORAGE	nvStorage,
		uint64	index,
		uint64	maxMsgCount,
		uint64	maxBytesCount,
		uint64 *	msgCount,
		uint64 *	byteCount,
		uint8 *	msg
	)

C#: public static extern UInt32 mxfRawEmbeddedNVStorageFileMsgRead(UInt64 nvStorage, UInt64 index, UInt64 maxMsgCount, UInt64 maxBytesCount, out UInt64 msgCount, out UInt64 byteCount, IntPtr msg);

Reads the records from a specific file. The messages format will be of raw sector type.

Note: This function is the specific version for raw sector of the multi-protocol mxfEmbeddedNVStorageFileMsgRead() function.

Parameters

[in]	nvStorage	non-volatile storage handle
[in]	index	file index
[in]	maxMsgCount	maximum number of messages that can be returned
[in]	maxBytesCount	maximum byte count that can be returned
[out]	msgCount	count of messages returned
[out]	byteCount	number of bytes returned in the msg buffer
[out]	msg	pointer to read buffer containing messages. The records in the buffer need to be indexed using the mxfNextRecordPtrGet() 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: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileStatusGet()

uint32 mxfUserDefEmbeddedNVStorageFileMsgRead	(	HMXF_NVSTORAGE	nvStorage,
		uint64	index,
		uint64	maxMsgCount,
		uint64	maxBytesCount,
		uint64 *	msgCount,
		uint64 *	byteCount,
		MXF_EMBEDDED_DATAREC *	msg
	)

C#: public static extern UInt32 mxfUserDefEmbeddedNVStorageFileMsgRead(UInt64 nvStorage, UInt64 index, UInt64 maxMsgCount, UInt64 maxBytesCount, out UInt64 msgCount, out UInt64 byteCount, IntPtr msg);

Reads the records from a specific file. The messages format will be of user defined type.

Note: This function is the specific version for raw sector of the multi-protocol mxfEmbeddedNVStorageFileMsgRead() function.

Parameters

[in]	nvStorage	non-volatile storage handle
[in]	index	file index
[in]	maxMsgCount	maximum number of messages that can be returned
[in]	maxBytesCount	maximum byte count that can be returned
[out]	msgCount	count of messages returned
[out]	byteCount	number of bytes returned in the msg buffer
[out]	msg	pointer to read buffer containing messages. The records in the buffer need to be indexed using the mxfNextRecordPtrGet() 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: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileStatusGet()

uint32 mxfEmbeddedNVStorageFileStatusGet	(	HMXF_NVSTORAGE	nvStorage,
		uint64	index,
		uint64 *	freeByte,
		uint64 *	unreadByte,
		uint64 *	bufferedWriteByte,
		uint64 *	overflow
	)

C#: public static extern UInt32 mxfEmbeddedNVStorageFileStatusGet(UInt64 nvStorage, UInt64 index, out UInt64 freeByte, out UInt64 unreadByte, out UInt64 bufferWriteByte, out UInt64 overflow);

Gets the status of the specified file index.

Parameters

[in]	nvStorage	non-volatile storage handle
[in]	index	file index
[out]	freeByte	file free byte count
[out]	unreadByte	file unread byte count
[out]	bufferedWriteByte	file buffered write count
[out]	overflow	file overflow

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: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileMsgRead()

uint32 mxfEmbeddedNVStorageFileMsgWrite	(	HMXF_NVSTORAGE	nvStorage,
		uint64	index,
		uint64	maxCount,
		void *	msg,
		uint64 *	count
	)

C#: public static extern UInt32 mxfEmbeddedNVStorageFileMsgWrite(UInt64 nvStorage, UInt64 index, UInt64 maxCount, IntPtr msg, out UInt64 count);

Writes messages to the specified file. The messages format must follow the message type of the file.

Parameters

[in] nvStorage non-volatile storage handle

[in] index file index

[in] maxCount maximum number of messages to write

[in]

msg

pointer to messages to write. The records in the buffer need to be indexed using mxfNextRecordPtrGet() function.

Type ID	Description
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_RAW_SECTOR	Records are formatted by sector. Use mxfEmbeddedNVStorageInfoGet() function to get the sector size.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A429	Records are formatted according to MXF_DATAREC_A429 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_CSDB	Records are formatted according to MXF_DATAREC_CSDB structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_DISCRETE	Records are formatted according to MXF_DATAREC_DISCRETE structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_MIL1553	Records are formatted according to MXF_DATAREC_MIL1553 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_ASYNC_ENHANCED	Records are formatted according to MXF_DATAREC_ASYNCEH structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A629	Records are formatted according to MXF_DATAREC_A629 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A717	Records are formatted according to MXF_DATAREC_A717 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A708	Records are formatted according to MXF_DATAREC_A708 structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_HDLC	Records are formatted according to MXF_DATAREC_HDLC structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_USERDEF	Records are formatted according to MXF_DATAREC_EMBEDDED structure.
MXF_EMBEDDED_NVSTORAGE_MSGTYPE_CANBUS	Read and write are formatted according to MXF_DATAREC_CANBUS structure.

[out] count number of messages actually written

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: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileStatusGet()

uint32 mxfRawEmbeddedNVStorageFileMsgWrite	(	HMXF_NVSTORAGE	nvStorage,
		uint64	index,
		uint64	maxCount,
		uint8 *	rec,
		uint64 *	count
	)

C#: public static extern UInt32 mxfRawEmbeddedNVStorageFileMsgWrite(UInt64 storage, UInt64 index, UInt64 maxCount, IntPtr rec, out UInt64 count);

Writes messages to the specified file. The messages format must must be of type raw sector.

Note: This function is the specific version for raw sector of the multi-protocol mxfEmbeddedNVStorageFileMsgWrite() function.

Parameters

[in]	nvStorage	non-volatile storage handle
[in]	index	file index
[in]	maxCount	maximum number of messages to write
[in]	rec	pointer to messages to write. The records in the buffer need to be indexed using mxfNextRecordPtrGet() function.
[out]	count	number of messages actually written

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: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileStatusGet()

uint32 mxfUserDefEmbeddedNVStorageFileMsgWrite	(	HMXF_NVSTORAGE	nvStorage,
		uint64	index,
		uint64	maxCount,
		MXF_EMBEDDED_DATAREC *	rec,
		uint64 *	count
	)

C#: public static extern UInt32 mxfUserDefEmbeddedNVStorageFileMsgWrite(UInt64 storage, UInt64 index, UInt64 maxCount, IntPtr rec, out UInt64 count);

Writes messages to the specified file. The messages format must must be of type user defined.

Note: This function is the specific version for raw sector of the multi-protocol mxfEmbeddedNVStorageFileMsgWrite() function.

Parameters

[in]	nvStorage	non-volatile storage handle
[in]	index	file index
[in]	maxCount	maximum number of messages to write
[in]	rec	pointer to messages to write. The records in the buffer need to be indexed using mxfNextRecordPtrGet() function.
[out]	count	number of messages actually written

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: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileStatusGet()

Functions

Detailed Description

Function Documentation