Functions
uint32	mxfA629AsyncEventRxMsgSelectSet (HMXF_ASYNCEVENT asyncEvent, HMXF_CHANNEL channel, uint64 select, uint64 maxCount, MXF_MSGID_A629 *msg)

uint32	mxfA629AsyncEventRxMsgSelectGet (HMXF_ASYNCEVENT asyncEvent, HMXF_CHANNEL channel, uint64 maxCount, uint64 count, MXF_MSGID_A629 msg)

uint32	mxfA629TxPeriodicMajorFrameSyncSet (HMXF_CHANNEL channel, uint64 majorIndex, uint64 columnIndex, MXF_A629_TXPERIODIC_MJRFRAME_SYNC *sync)

uint32	mxfA629TxPeriodicMajorFrameSyncGet (HMXF_CHANNEL channel, uint64 majorIndex, uint64 columnIndex, MXF_A629_TXPERIODIC_MJRFRAME_SYNC *sync)

uint32	mxfA629TxPeriodicMajorFrameStart (HMXF_CHANNEL channel, uint64 majorIndex, MXF_A629_TXPERIODIC_MJRFRAME_PROPERTIES *properties)

uint32	mxfA629TxPeriodicMajorFrameGet (HMXF_CHANNEL channel, uint64 majorIndex, uint64 minorIndex, uint64 maxCount, uint64 count, MXF_A629_TXPERIODIC_MJRFRAME_MSG msg)

uint32	mxfA629TxPeriodicMajorFrameSet (HMXF_CHANNEL channel, uint64 majorIndex, uint64 minorIndex, uint64 count, MXF_A629_TXPERIODIC_MJRFRAME_MSG *msg)

uint32	mxfA629TxPeriodicUpdateMsgWrite (HMXF_BUFFER buffer, uint64 count, MXF_A629_DATAREC *rec)

uint32	mxfA629RxAcqMsgSelectGet (HMXF_BUFFER buffer, uint64 maxCount, uint64 count, uint64 labels)

uint32	mxfA629RxAcqMsgSelectSet (HMXF_BUFFER buffer, uint64 select, uint64 maxCount, uint64 *labels)

uint32	mxfA629RxAcqRead (HMXF_BUFFER buffer, uint64 maxRecCount, uint64 maxBytesCount, uint64 status, uint64 recCount, uint64 bytesCount, MXF_A629_DATAREC rec)

uint32	mxfA629RxSamplingMsgSelectGet (HMXF_BUFFER buffer, uint64 maxCount, uint64 count, uint64 labels)

uint32	mxfA629RxSamplingMsgSelectSet (HMXF_BUFFER buffer, uint64 select, uint64 count, uint64 *labels)

uint32	mxfA629RxSamplingExtEnableSet (HMXF_BUFFER buffer, uint64 state, uint64 count, uint64 *labels)

uint32	mxfA629RxSamplingExtEnableAllGet (HMXF_BUFFER buffer, uint64 maxCount, uint64 count, uint64 labels)

uint32	mxfA629RxSamplingRead (HMXF_BUFFER buffer, uint64 flags, uint64 maxRecCount, uint64 maxBytesCount, uint64 recCount, uint64 byteCount, MXF_A629_SAMPREC *rec)

uint32	mxfA629RxSamplingSingleRead (HMXF_BUFFER buffer, uint64 flags, uint64 label, uint64 cid, MXF_A629_SAMPREC *rec)

uint32	mxfA629NextDataRecordPtrGet (MXF_A629_DATAREC currentRec, MXF_A629_DATAREC *nextRec)

uint32	mxfA629NextSamplingRecordPtrGet (MXF_A629_SAMPREC currentRec, MXF_A629_SAMPREC *nextRec)

uint32	mxfA629ErrorInjectionCompose (uint64 id, uint64 param, uint16 *error)

uint32	mxfA629ErrorInjectionSet (HMXF_CHANNEL channel, uint64 errorIndex, MXF_A629_ERROR_INJ *error)

uint32	mxfA629ErrorInjectionGet (HMXF_CHANNEL channel, uint64 errorIndex, MXF_A629_ERROR_INJ *error)

uint32	mxfA629ErrorInjectionCountGet (HMXF_CHANNEL channel, uint64 *errorCount)

uint32	mxfA629RxMsgCrcEnableSet (HMXF_CHANNEL channel, uint64 label, uint64 cid, uint64 enable)

	mxfA629RxMsgCrcEnableAllSet (HMXF_CHANNEL channel, uint64 enable, uint64 count, MXF_MSGID_A629 *msgIdTab)

uint32	mxfA629RxMsgCrcEnableGet (HMXF_CHANNEL channel, uint64 label, uint64 cid, uint64 *enable)

uint32	mxfA629RxMsgCrcEnableAllGet (HMXF_CHANNEL channel, uint64 maxCount, uint64 count, MXF_MSGID_A629 msgIdTab)

uint32	mxfA629MsgFreshnessCounterSet (HMXF_BUFFER buffer, MXF_A629_FC *fc)

uint32	mxfA629MsgFreshnessCounterGet (HMXF_BUFFER buffer, MXF_A629_FC *fc)

uint32	mxfA629EmbeddedNVStorageFileMsgSelectSet (HMXF_CHANNEL channel, uint64 select, uint64 count, MXF_MSGID_A629 *msgid)

uint32	mxfA629EmbeddedNVStorageFileMsgSelectGet (HMXF_CHANNEL channel, uint64 maxCount, uint64 count, MXF_MSGID_A629 msgid)

uint32	mxfA629EmbeddedNVStorageFileMsgRead (HMXF_NVSTORAGE nvStorage, uint64 fileIndex, uint64 maxMsgCount, uint64 maxBytesCount, uint64 msgCount, uint64 byteCount, MXF_A629_DATAREC *msg)

uint32	mxfA629EmbeddedNVStorageFileMsgWrite (HMXF_NVSTORAGE nvStorage, uint64 fileIndex, uint64 maxRecCount, MXF_A629_DATAREC msg, uint64 count)

Detailed Description

Function Documentation

uint32 mxfA629AsyncEventRxMsgSelectSet	(	HMXF_ASYNCEVENT	asyncEvent,
		HMXF_CHANNEL	channel,
		uint64	select,
		uint64	maxCount,
		MXF_MSGID_A629 *	msg
	)

C#: public static extern UInt32 mxfA629AsyncEventRxMsgSelectSet(UInt64 asyncEvent, UInt64 channel, UInt64 select, UInt64 maxCount, MXF_MSGID_A629[] msg);

public static extern UInt32 mxfA629AsyncEventRxMsgSelectSet(UInt64 asyncEvent, UInt64 channel, UInt64 select, UInt64 maxCount, IntPtr msg);

Selects or deselects the label-cid pair (message id) for MXF_ASYNCEVENT_COND_RX_MSG condition on a specified RX channel.

The function must be called in addition to the mxfAsyncEventConditionsSet() function with MXF_ASYNCEVENT_COND_RX_MSG condition to cause an asynchronous event to occur when a specific label-cid is received.

The message selection must be made by only one asynchronous event routine for a specific channel. Otherwise, an error code will be returned while conditions of other asynchronous event routines are present.

In this case, you must disable the MXF_ASYNCEVENT_COND_RX_MSG condition using mxfAsyncEventConditionsSet() function using another asynchronous event handle.

Note: count set to 0 with msg set to NULL means ALL label-cid.; This function is the specific version for ARINC 629 of the multi-protocol mxfAsyncEventRxMsgSelectSet() function.

Parameters

[in] asyncEvent asynchronous event handle.

[in] channel channel handle.

[in]

select

action to perform for the message ID.

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

[in] maxCount count of messages id.

[in] msg address of array of message 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: mxfAsyncEventRxMsgSelectSet(); mxfAsyncEventHandlerInit(); mxfA629AsyncEventRxMsgSelectGet(); mxfAsyncEventConditionsSet()

uint32 mxfA629AsyncEventRxMsgSelectGet	(	HMXF_ASYNCEVENT	asyncEvent,
		HMXF_CHANNEL	channel,
		uint64	maxCount,
		uint64 *	count,
		MXF_MSGID_A629 *	msg
	)

C#: public static extern UInt32 mxfA629AsyncEventRxMsgSelectGet(UInt64 asyncEvent, UInt64 channel, UInt64 maxCount, out UInt64 count, [Out] MXF_MSGID_A629[] msg);

Returns the list of message IDs registered for a specified RX channel for the MXF_ASYNCEVENT_COND_RX_MSG asynchronous event condition ID.

Note: This function is the specific version for ARINC 629 of the multi-protocol mxfAsyncEventRxMsgSelectGet() function.

Parameters

[in]	asyncEvent	asynchronous event handle.
[in]	channel	channel handle.
[in]	maxCount	maximum ID messages expected.
[out]	count	number of ID messages returned.
[out]	msg	returned message ID 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: mxfAsyncEventRxMsgSelectGet(); mxfAsyncEventHandlerInit(); mxfA629AsyncEventRxMsgSelectSet(); mxfAsyncEventConditionsSet()

uint32 mxfA629TxPeriodicMajorFrameSyncSet	(	HMXF_CHANNEL	channel,
		uint64	majorIndex,
		uint64	columnIndex,
		MXF_A629_TXPERIODIC_MJRFRAME_SYNC *	sync
	)

C#: public static extern UInt32 mxfA629TxPeriodicMajorFrameSyncSet(UInt64 channel, UInt64 majorIndex, UInt64 columnIndex, ref MXF_A629_TXPERIODIC_MJRFRAME_SYNC sync);

Sets the specified synchronize frame to the major frame.

Parameters

[in]	channel	channel handle.
[in]	majorIndex	major frame index. Reserved for future use. Must be set to 0.
[in]	columnIndex	Sync frame index (0-30).
[in]	sync	pointer to major frame synchronize frame structure to set.

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

Examples:: ar629_alternate.c, ar629_alternate.cs, ar629_independent_mode.c, and ar629_independent_mode.cs.

uint32 mxfA629TxPeriodicMajorFrameSyncGet	(	HMXF_CHANNEL	channel,
		uint64	majorIndex,
		uint64	columnIndex,
		MXF_A629_TXPERIODIC_MJRFRAME_SYNC *	sync
	)

C#: public static extern UInt32 mxfA629TxPeriodicMajorFrameSyncGet(UInt64 channel, UInt64 majorIndex, UInt64 columnIndex, out MXF_A629_TXPERIODIC_MJRFRAME_SYNC sync);

This function returns the specified synchronize frame of the major frame.

Parameters

[in]	channel	channel handle.
[in]	majorIndex	major frame index. Reserved for future use. Must be set to 0.
[in]	columnIndex	Sync frame index (0-30).
[out]	sync	pointer to major frame synchronize frame 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: mxfA629TxPeriodicMajorFrameSyncSet()

uint32 mxfA629TxPeriodicMajorFrameStart	(	HMXF_CHANNEL	channel,
		uint64	majorIndex,
		MXF_A629_TXPERIODIC_MJRFRAME_PROPERTIES *	properties
	)

C#: public static extern UInt32 mxfA629TxPeriodicMajorFrameStart(UInt64 channel, UInt64 majorIndex, ref MXF_A629_TXPERIODIC_MJRFRAME_PROPERTIES properties);

Starts the major frame.

If the major frame contains frame errors, erroneous frames will be ignored and others frames will be started.

The data of the major frame must be initialized using mxfA629TxPeriodicUpdateMsgWrite() function.

Note: This function is the specific version for A629 of the multi-protocol mxfTxPeriodicMajorFrameStart() function.

Parameters

[in]	channel	channel handle.
[in]	majorIndex	major frame index. Reserved for future use. Must be set to 0.
[in]	properties	address of a MXF_A629_TXPERIODIC_MJRFRAME_PROPERTIES structure. If not specified block mode is assumed.

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: mxfTxPeriodicMajorFrameStart(); mxfModuleChannelAllGet(); mxfTxPeriodicMajorFrameStop(); mxfA629TxPeriodicUpdateMsgWrite()

Examples:: ar629_alternate.c, ar629_alternate.cs, ar629_aperiodic_frame.c, ar629_aperiodic_frame.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, and ar629_updating_data_sampling.cs.

uint32 mxfA629TxPeriodicMajorFrameGet	(	HMXF_CHANNEL	channel,
		uint64	majorIndex,
		uint64	minorIndex,
		uint64	maxCount,
		uint64 *	count,
		MXF_A629_TXPERIODIC_MJRFRAME_MSG *	msg
	)

C#: public static extern UInt32 mxfA629TxPeriodicMajorFrameGet(UInt64 channel, UInt64 majorIndex, UInt64 minorIndex, UInt64 maxCount, out UInt64 count, out MXF_A629_TXPERIODIC_MJRFRAME_MSG msg);

Reads the specified minor frame of the major frame.

Note: This function is the specific version for A629 of the multi-protocol mxfTxPeriodicMajorFrameGet() function.

Parameters

[in]	channel	channel handle.
[in]	majorIndex	major frame index. Reserved for future use. Must be set to 0.
[in]	minorIndex	minor frame index (0-31).
[in]	maxCount	maximum messages to read within the minor frame (0-31).
[out]	count	returned messages count.
[out]	msg	minor frame messages pointer.

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: mxfTxPeriodicMajorFrameGet(); mxfA629TxPeriodicMajorFrameSet()

uint32 mxfA629TxPeriodicMajorFrameSet	(	HMXF_CHANNEL	channel,
		uint64	majorIndex,
		uint64	minorIndex,
		uint64	count,
		MXF_A629_TXPERIODIC_MJRFRAME_MSG *	msg
	)

C#: public static extern UInt32 mxfA629TxPeriodicMajorFrameSet(UInt64 channel, UInt64 majorIndex, UInt64 minorIndex, UInt64 count, MXF_A629_TXPERIODIC_MJRFRAME_MSG[] msg);

Sets the specified minor frame to the major frame by passing an array of structure of messages.

This function is used before enabling the transmission of the schedule for configuring each minor frame of the major frame.

Note: This function is the specific version for A629 of the multi-protocol mxfTxPeriodicMajorFrameSet() function.

Parameters

[in]	channel	channel handle.
[in]	majorIndex	major frame index. Reserved for future use. Must be set to 0.
[in]	minorIndex	minor frame index (0-31).
[in]	count	count of messages in the minor frame (0-31).
[in]	msg	minor frame message structure pointer.

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: mxfTxPeriodicMajorFrameSet(); mxfA629TxPeriodicMajorFrameStart(); mxfA629TxPeriodicMajorFrameGet()

Examples:: ar629_alternate.c, ar629_alternate.cs, ar629_aperiodic_frame.c, ar629_aperiodic_frame.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, and ar629_updating_data_sampling.cs.

uint32 mxfA629TxPeriodicUpdateMsgWrite	(	HMXF_BUFFER	buffer,
		uint64	count,
		MXF_A629_DATAREC *	rec
	)

C#: public static extern UInt32 mxfA629TxPeriodicUpdateMsgWrite(UInt64 buffer, UInt64 count, IntPtr rec)

Writes messages of the record array into the specified buffer. The last message of each buffer is sent forever until a new message is written into the buffer.

Note: This function is the specific version for A629 of the multi-protocol mxfTxPeriodicUpdateMsgWrite() function.

Parameters

[in]	buffer	buffer handle.
[in]	count	count of records to write.
[in]	rec	array of record(s) to write. The records in the buffer need to be indexed using mxfA629NextDataRecordPtrGet() 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: mxfTxPeriodicUpdateMsgWrite(); mxfTxPeriodicUpdateMsgBufferAlloc(); mxfTxPeriodicUpdateMsgBufferStatusGet(); mxfTxPeriodicUpdateMsgClear(); mxfA629NextDataRecordPtrGet()

Examples:: ar629_alternate.c, ar629_alternate.cs, ar629_aperiodic_frame.c, ar629_aperiodic_frame.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, and ar629_updating_data_sampling.cs.

uint32 mxfA629RxAcqMsgSelectGet	(	HMXF_BUFFER	buffer,
		uint64	maxCount,
		uint64 *	count,
		uint64 *	labels
	)

C#: public static extern UInt32 mxfA629RxAcqMsgSelectGet(UInt64 buffer, UInt64 maxCount, out UInt64 count, [Out] UInt64[] labels);

Returns the list of labels selected for acquisition.

Note: This function is the specific version for A629 of the multi-protocol mxfRxAcqMsgSelectGet() function.

Parameters

[in]	buffer	buffer handle.
[in]	maxCount	maximum number of labels in the array.
[out]	count	returned number of labels in the labels array.
[out]	labels	address of the returned labels 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: mxfRxAcqMsgSelectGet(); mxfRxAcqBufferAlloc(); mxfRxAcqBufferGet(); mxfA629RxAcqMsgSelectSet()

uint32 mxfA629RxAcqMsgSelectSet	(	HMXF_BUFFER	buffer,
		uint64	select,
		uint64	maxCount,
		uint64 *	labels
	)

C#: public static extern UInt32 mxfA629RxAcqMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 maxCount, UInt64[] labels);

public static extern UInt32 mxfA629RxAcqMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 maxCount, IntPtr labels);

Selects or deselects the label(s) to be acquired on the specified acquisition buffer.

Upon data arrival, the embedded process will check if the received message label is found in the current selection list. The receive data record will be added to the acquisition buffer only if the message label is found in the selection list, otherwise it is discarded.

By default, after a device reset, no filtering is performed and all messages are received.

Note: count set to 0 with labels set to NULL means ALL messages.; This function is the specific version for A629 of the multi-protocol mxfRxAcqMsgSelectSet() function.

Parameters

[in] buffer buffer handle.

[in]

select

action to perform with the message labels array.

Option	Description
MXF_MSG_DESELECT	Deselects the message labels.
MXF_MSG_SELECT_ADD	Adds the specified message labels.
MXF_MSG_SELECT_ONLY	Replaces the current selection with the provided list.

[in] maxCount number of entries in labels.

[in] labels address of array of labels

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: mxfRxAcqMsgSelectSet(); mxfRxAcqBufferAlloc(); mxfRxAcqBufferGet(); mxfA629RxAcqMsgSelectGet()

uint32 mxfA629RxAcqRead	(	HMXF_BUFFER	buffer,
		uint64	maxRecCount,
		uint64	maxBytesCount,
		uint64 *	status,
		uint64 *	recCount,
		uint64 *	bytesCount,
		MXF_A629_DATAREC *	rec
	)

C#: public static extern UInt32 mxfA629RxAcqRead(UInt64 buffer, UInt64 maxRecCount, UInt64 maxBytesCount, out UInt64 status, out UInt64 recCount, out UInt64 bytesCount, IntPtr rec);

Transfers the records from the channel acquisition buffer to the calling application.

Note: This function is the specific version for A629 of the multi-protocol mxfRxAcqRead() function.

Parameters

[in]	buffer	buffer handle.
[in]	maxRecCount	maximum number records to read (0 means all messages).
[in]	maxBytesCount	maximum number of bytes to be read.
[out]	status	last status set.
[out]	recCount	number of records returned.
[out]	bytesCount	number of bytes returned.
[out]	rec	address of data records. The records in the buffer need to be indexed using mxfA629NextDataRecordPtrGet() 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: mxfRxAcqRead(); mxfRxAcqStart(); mxfRxAcqBufferAlloc(); mxfRxAcqStop(); mxfA629NextDataRecordPtrGet()

Examples:: 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_freshnessCounter_manyCID.c, ar629_freshnessCounter_manyCID.cs, ar629_independent_mode.c, and ar629_independent_mode.cs.

uint32 mxfA629RxSamplingMsgSelectGet	(	HMXF_BUFFER	buffer,
		uint64	maxCount,
		uint64 *	count,
		uint64 *	labels
	)

C#: public static extern UInt32 mxfA629RxSamplingMsgSelectGet(UInt64 buffer, UInt64 maxCount, out UInt64 count, [Out] UInt64[] labels);

Returns the list of labels selected for sampling.

Note: This function is the specific version for A629 of the multi-protocol mxfRxSamplingMsgSelectGet() function.

Parameters

[in]	buffer	buffer handle.
[in]	maxCount	maximum number of labels in the array labels.
[out]	count	returned number of labels in the labels array.
[out]	labels	address of the returned labels 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: mxfRxSamplingMsgSelectGet(); mxfRxSamplingBufferAlloc(); mxfRxSamplingStart(); mxfA629RxSamplingRead(); mxfA629RxSamplingMsgSelectSet()

uint32 mxfA629RxSamplingMsgSelectSet	(	HMXF_BUFFER	buffer,
		uint64	select,
		uint64	count,
		uint64 *	labels
	)

C#: public static extern UInt32 mxfA629RxSamplingMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 count, UInt64[] labels);

public static extern UInt32 mxfA629RxSamplingMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 count, IntPtr labels);

Selects or deselects the labels(s) to be received on the specified sampling buffer.

Upon data arrival, the embedded process check if the received label is defined in the current selection list. The receive data record will be added to the sampling buffer only if the label was added previously in the selection list, otherwise it is discarded.

By default, after a device reset, no filtering is performed and all labels are received.

Note: count set to 0 with labels set to NULL means ALL labels.; This function is the specific version for A629 of the multi-protocol mxfRxSamplingMsgSelectSet() function.

Parameters

[in] buffer buffer handle.

[in]

select

action to perform with the labels array.

Option	Description
MXF_MSG_DESELECT	Deselects the label(s).
MXF_MSG_SELECT_ADD	Adds the specified label(s).
MXF_MSG_SELECT_ONLY	Replaces the current selection with the provided list.

[in] count count of labels in the array.

[in] labels address of array of labels.

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: mxfRxSamplingMsgSelectSet(); mxfRxSamplingBufferAlloc(); mxfRxSamplingStart(); mxfA629RxSamplingRead(); mxfA629RxSamplingMsgSelectGet()

uint32 mxfA629RxSamplingExtEnableSet	(	HMXF_BUFFER	buffer,
		uint64	state,
		uint64	count,
		uint64 *	labels
	)

C#: public static extern UInt32 mxfA629RxSamplingExtEnableSet(UInt64 buffer, UInt64 state, UInt64 count, UInt64[] labels);

public static extern UInt32 mxfA629RxSamplingExtEnableSet(UInt64 buffer, UInt64 state, UInt64 count, IntPtr labels);

Enables or disables message discrimination using the CID. The message look-up table will have an entry for each message label-CID pair.

Note: count set to 0 with labels set to NULL means ALL labels.; This function is the specific version for A629 of the multi-protocol mxfRxSamplingExtEnableSet() function.

Parameters

[in] buffer buffer handle.

[in]

state

extension filtering state.

State	Description
VMXF_ENABLE	Enable extension filtering.
VMXF_DISABLE	Disable extension filtering.

[in] count number of entries in labels.

[in] labels address of array of labels.

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: mxfRxSamplingExtEnableSet(); mxfA629RxSamplingExtEnableAllGet()

uint32 mxfA629RxSamplingExtEnableAllGet	(	HMXF_BUFFER	buffer,
		uint64	maxCount,
		uint64 *	count,
		uint64 *	labels
	)

C#: public static extern UInt32 mxfA629RxSamplingExtEnableAllGet(UInt64 buffer, UInt64 maxCount, out UInt64 count, [Out] UInt64[] labels);

Returns the list of labels that have message discrimination using the CID enabled.

Note: This function is the specific version for A629 of the multi-protocol mxfRxSamplingExtEnableAllGet() function.

Parameters

[in]	buffer	buffer handle.
[in]	maxCount	maximum number of entries in labels.
[out]	count	number of entries in labels.
[out]	labels	address array of labels.

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: mxfRxSamplingExtEnableAllGet(); mxfA629RxSamplingExtEnableSet()

uint32 mxfA629RxSamplingRead	(	HMXF_BUFFER	buffer,
		uint64	flags,
		uint64	maxRecCount,
		uint64	maxBytesCount,
		uint64 *	recCount,
		uint64 *	byteCount,
		MXF_A629_SAMPREC *	rec
	)

C#: public static extern UInt32 mxfA629RxSamplingRead(UInt64 buffer, UInt64 flags, UInt64 maxRecCount, UInt64 maxBytesCount, out UInt64 recCount, out UInt64 bytesCount, IntPtr rec);

Reads the sampling records from the sampling buffer to the application buffer.

The sampling process maintains records for all of the received labels. A label is considered received if corresponding data words were received within the kill-time period. A record refresh from the receive port resets the kill-time timer and an updated copy is made available to the application.

The sampling record contains information on the arrival rate and the number of errors, as well as the latest data received for that address.

Note: This function is the specific version for A629 of the multi-protocol mxfRxSamplingRead() function.

Parameters

[in] buffer buffer handle.

[in]

flags

option flag.

Flags	Description
MXF_RXSAMPLING_FLAG_DEFAULT	The record is kept in the buffer and the same record can be read again by the current or another application.
MXF_RXSAMPLING_FLAG_ERASE_WHEN_READ	After the sampling record is returned, it is removed from the buffer.

[in] maxRecCount maximum number of messages to read (0 means all messages).

[in] maxBytesCount maximum number of bytes to read.

[out] recCount number of messages returned.

[out] byteCount number of bytes returned.

[out] rec array of message record structure. The records in the buffer must be indexed by using mxfA629NextSamplingRecordPtrGet() 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: mxfRxSamplingRead(); mxfRxSamplingBufferAlloc(); mxfA629RxSamplingMsgSelectSet(); mxfRxSamplingStart(); mxfA629NextSamplingRecordPtrGet()

Examples:: ar629_error_injection_detection.c, ar629_error_injection_detection.cs, ar629_updating_data_sampling.c, and ar629_updating_data_sampling.cs.

uint32 mxfA629RxSamplingSingleRead	(	HMXF_BUFFER	buffer,
		uint64	flags,
		uint64	label,
		uint64	cid,
		MXF_A629_SAMPREC *	rec
	)

C#: public static extern UInt32 mxfA629RxSamplingSingleRead(UInt64 buffer, UInt64 flags, UInt64 label, UInt64 cid, IntPtr rec);

Reads a specific sampling record from the sampling buffer.

Note: This function is the specific version for A629 of the multi-protocol mxfRxSamplingSingleRead() function.

Parameters

[in] buffer buffer handle.

[in]

flags

option flag.

Flags	Description
MXF_RXSAMPLING_FLAG_DEFAULT	The record is kept in the buffer and the same record can be read again by the current or another application.
MXF_RXSAMPLING_FLAG_ERASE_WHEN_READ	After the sampling record is returned, it is removed from the buffer.

[in] label message label.

[in] cid message cid.

[out] rec address of sampling record.

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: mxfRxSamplingSingleRead(); mxfRxSamplingBufferAlloc(); mxfA629RxSamplingMsgSelectSet(); mxfRxSamplingStart(); mxfRxSamplingStop()

uint32 mxfA629NextDataRecordPtrGet	(	MXF_A629_DATAREC *	currentRec,
		MXF_A629_DATAREC **	nextRec
	)

C#: public static extern UInt32 mxfA629NextDataRecordPtrGet(IntPtr currentRec, out IntPtr nextRec);

Returns the next buffer address in a MXF_A629_DATAREC buffer array.

Note: This function is the specific version for A629 of the multi-protocol mxfNextRecordPtrGet() function.

Parameters

[in]	currentRec	pointer to the beginning or the current record in the buffer.
[out]	nextRec	pointer to next record in the 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: mxfNextRecordPtrGet(); mxfA629RxAcqRead(); mxfA629TxPeriodicUpdateMsgWrite(); mxfA629NextSamplingRecordPtrGet()

Examples:: 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_freshnessCounter_manyCID.c, ar629_freshnessCounter_manyCID.cs, ar629_independent_mode.c, and ar629_independent_mode.cs.

uint32 mxfA629NextSamplingRecordPtrGet	(	MXF_A629_SAMPREC *	currentRec,
		MXF_A629_SAMPREC **	nextRec
	)

C#: public static extern UInt32 mxfA629NextSamplingRecordPtrGet(IntPtr currentRec, out IntPtr nextRec);

Returns the next buffer address in a MXF_A629_SAMPREC buffer array.

Note: This function is the specific version for A629 of the multi-protocol mxfNextRecordPtrGet() function.

Parameters

[in]	currentRec	pointer to the beginning or the current record in the buffer.
[out]	nextRec	pointer to next record in the 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: mxfNextRecordPtrGet(); mxfA629RxSamplingRead(); mxfA629NextDataRecordPtrGet()

Examples:: ar629_error_injection_detection.c, ar629_error_injection_detection.cs, ar629_updating_data_sampling.c, and ar629_updating_data_sampling.cs.

uint32 mxfA629ErrorInjectionCompose	(	uint64	id,
		uint64	param,
		uint16 *	error
	)

C#: public static extern UInt32 mxfA629ErrorInjectionCompose(UInt64 id, UInt64 param, out UInt16 error);

Helps to generate the errors field of MXF_A629_ERROR_INJ.

Parameters

[in]	id	error injection ID.
[in]	param	parameter for the error injection.
[out]	error	pointer to the error in the errors 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: mxfA629ErrorInjectionSet()

Examples:: ar629_error_injection_detection.c, and ar629_error_injection_detection.cs.

uint32 mxfA629ErrorInjectionSet	(	HMXF_CHANNEL	channel,
		uint64	errorIndex,
		MXF_A629_ERROR_INJ *	error
	)

C#: public static extern UInt32 mxfA629ErrorInjectionSet(UInt64 channel, UInt64 errorIndex, ref MXF_A629_ERROR_INJ error);

Updates the specified error injection structure. By default, all errors are set to zero until this function is called.

Parameters

[in]	channel	Channel handle.
[in]	errorIndex	Error index (0-99).
[in]	error	Error structure pointer.

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

Examples:: ar629_error_injection_detection.c, and ar629_error_injection_detection.cs.

uint32 mxfA629ErrorInjectionGet	(	HMXF_CHANNEL	channel,
		uint64	errorIndex,
		MXF_A629_ERROR_INJ *	error
	)

C#: public static extern UInt32 mxfA629ErrorInjectionGet(UInt64 channel, UInt64 errorIndex, out MXF_A629_ERROR_INJ error);

Reads the specified error injection structure.

Parameters

[in]	channel	Channel handle.
[in]	errorIndex	Error index (0-99).
[out]	error	Error structure pointer.

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

uint32 mxfA629ErrorInjectionCountGet	(	HMXF_CHANNEL	channel,
		uint64 *	errorCount
	)

C#: public static extern UInt32 mxfA629ErrorInjectionCountGet(UInt64 channel, out UInt64 errorCount);

Gets the maximum number of error injections that can be set.

Parameters

[in]	channel	Channel handle.
[out]	errorCount	number of error injections.

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: mxfA629ErrorInjectionSet(); mxfA629ErrorInjectionGet()

uint32 mxfA629RxMsgCrcEnableSet	(	HMXF_CHANNEL	channel,
		uint64	label,
		uint64	cid,
		uint64	enable
	)

C#: public static extern UInt32 mxfA629RxMsgCrcEnableSet(UInt64 channel, UInt64 label, UInt64 cid, UInt64 enable);

Sets the CRC enable state of the specified message defined on a channel.

Parameters

[in] channel channel handle.

[in] label message label.

[in] cid message cid.

[in]

enable

value to set.

State	Description
VMXF_ENABLE	Enable CRC.
VMXF_DISABLE	Disable CRC.

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: mxfA629RxMsgCrcEnableGet(); mxfA629RxMsgCrcEnableAllSet()

Examples:: ar629_block_mode.c, ar629_block_mode.cs, ar629_independent_mode.c, and ar629_independent_mode.cs.

mxfA629RxMsgCrcEnableAllSet	(	HMXF_CHANNEL	channel,
		uint64	enable,
		uint64	count,
		MXF_MSGID_A629 *	msgIdTab
	)

C#: public static extern UInt32 mxfA629RxMsgCrcEnableAllSet(UInt64 channel, UInt64 enable, UInt64 count, MXF_MSGID_A629[] msgIdTab);

Sets the CRC enable state of the specified messages defined on a channel.

Parameters

[in] channel channel handle.

[in]

enable

value to set.

State	Description
VMXF_ENABLE	Enable CRC.
VMXF_DISABLE	Disable CRC.

[in] count number of messages in msgIdTab.

[in] msgIdTab Pointer to array of messages 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.4.2 and later.

See also: mxfA629RxMsgCrcEnableSet(); mxfA629RxMsgCrcEnableAllGet()

uint32 mxfA629RxMsgCrcEnableGet	(	HMXF_CHANNEL	channel,
		uint64	label,
		uint64	cid,
		uint64 *	enable
	)

C#: public static extern UInt32 mxfA629RxMsgCrcEnableGet(UInt64 channel, UInt64 label, UInt64 cid, out UInt64 enable);

This function returns the CRC enable state of the specified message defined on a channel.

Parameters

[in] channel channel handle.

[in] label message label.

[in] cid message cid.

[out]

enable

pointer to returned value.

State	Description
VMXF_ENABLE	CRC enabled.
VMXF_DISABLE	CRC 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: mxfA629RxMsgCrcEnableSet()

uint32 mxfA629RxMsgCrcEnableAllGet	(	HMXF_CHANNEL	channel,
		uint64	maxCount,
		uint64 *	count,
		MXF_MSGID_A629 *	msgIdTab
	)

C#: public static extern UInt32 mxfA629RxMsgCrcEnableAllGet(UInt64 channel, UInt64 maxCount, out UInt64 count, [Out] MXF_MSGID_A629[] msgIdTab);

This function returns the messages ID that have CRC enabled defined on a channel.

Parameters

[in]	channel	channel handle.
[in]	maxCount	size of msgIdTab.
[out]	count	number of messages ID returned in msgIdTab.
[out]	msgIdTab	pointer to array of messages 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.4.2 and later.

See also: mxfA629RxMsgCrcEnableAllSet(); mxfA629RxMsgCrcEnableGet()

uint32 mxfA629MsgFreshnessCounterSet	(	HMXF_BUFFER	buffer,
		MXF_A629_FC *	fc
	)

C#: public static extern UInt32 mxfA629MsgFreshnessCounterSet(UInt64 buffer, ref MXF_A629_FC fc);

Sets the Freshness Counter of the specified buffer.

Parameters

[in]	buffer	TX Periodic Update Message buffer handle.
[in]	fc	Pointer to Freshness Counter structure info.

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

Examples:: ar629_block_mode.c, ar629_block_mode.cs, ar629_freshnessCounter_manyCID.c, ar629_freshnessCounter_manyCID.cs, ar629_independent_mode.c, and ar629_independent_mode.cs.

uint32 mxfA629MsgFreshnessCounterGet	(	HMXF_BUFFER	buffer,
		MXF_A629_FC *	fc
	)

C#: public static extern UInt32 mxfA629MsgFreshnessCounterGet(UInt64 buffer, out MXF_A629_FC fc);

This function returns the Freshness Counter info of the specified buffer.

Parameters

[in]	buffer	TX Periodic Update Message buffer handle.
[out]	fc	pointer to returned Freshness Counter 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: mxfA629MsgFreshnessCounterSet()

uint32 mxfA629EmbeddedNVStorageFileMsgSelectSet	(	HMXF_CHANNEL	channel,
		uint64	select,
		uint64	count,
		MXF_MSGID_A629 *	msgid
	)

C#: public static extern UInt32 mxfA629EmbeddedNVStorageFileMsgSelectSet(UInt64 channel, UInt64 select, UInt64 count, MXF_MSGID_A629[] msgid);

public static extern UInt32 mxfA629EmbeddedNVStorageFileMsgSelectSet(UInt64 channel, UInt64 select, UInt64 count, IntPtr msgid);

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.; This function is the specific version for A629 of the multi-protocol mxfEmbeddedNVStorageFileMsgSelectSet() function.

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] msgid pointer to an array of message identifiers.

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 mxfA629EmbeddedNVStorageFileMsgSelectGet	(	HMXF_CHANNEL	channel,
		uint64	maxCount,
		uint64 *	count,
		MXF_MSGID_A629 *	msgid
	)

C#: public static extern UInt32 mxfA629EmbeddedNVStorageFileMsgSelectGet(UInt64 channel, UInt64 maxCount, out UInt64 count, [Out] MXF_MSGID_A629[] msgid);

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

Note: This function is the specific version for A629 of the multi-protocol mxfEmbeddedNVStorageFileMsgSelectGet() function.

Parameters

[in]	channel	channel handle.
[in]	maxCount	maximum count of messages return in the array
[out]	count	count of messages returned
[out]	msgid	pointer to an array of message identifiers.

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 mxfA629EmbeddedNVStorageFileMsgRead	(	HMXF_NVSTORAGE	nvStorage,
		uint64	fileIndex,
		uint64	maxMsgCount,
		uint64	maxBytesCount,
		uint64 *	msgCount,
		uint64 *	byteCount,
		MXF_A629_DATAREC *	msg
	)

C#: public static extern UInt32 mxfA629EmbeddedNVStorageFileMsgRead(UInt64 nvStorage, UInt64 fileIndex, UInt64 maxRecCount, UInt64 maxBytesCount, out UInt64 recCount, out UInt64 bytesCount, IntPtr rec);

Reads the records from a specific file. The messages format must be of type MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A629.

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

Parameters

[in]	nvStorage	non-volatile storage handle
[in]	fileIndex	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 mxfA629NextDataRecordPtrGet() 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 mxfA629EmbeddedNVStorageFileMsgWrite	(	HMXF_NVSTORAGE	nvStorage,
		uint64	fileIndex,
		uint64	maxRecCount,
		MXF_A629_DATAREC *	msg,
		uint64 *	count
	)

C#: public static extern UInt32 mxfA629EmbeddedNVStorageFileMsgWrite(UInt64 nvStorage, UInt64 fileIndex, UInt64 maxRecCount, IntPtr rec, out UInt64 count);

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

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

Parameters

[in]	nvStorage	non-volatile storage handle
[in]	fileIndex	file index
[in]	maxRecCount	maximum number of messages to write
[in]	msg	pointer to messages to write. The records in the buffer need to be indexed using mxfA629NextDataRecordPtrGet() 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