MX Foundation 4

Functions

uint32 mxfASCBTxPeriodicMajorFrameSet (HMXF_CHANNEL channel, uint64 minorIndex, uint64 count, MXF_ASCB_TXPERIODIC_MJRFRAME_MSG *msg)
 
uint32 mxfASCBTxPeriodicMajorFrameGet (HMXF_CHANNEL channel, uint64 minorIndex, uint64 maxCount, uint64 *count, MXF_ASCB_TXPERIODIC_MJRFRAME_MSG *msg)
 
uint32 mxfASCBTxPeriodicUpdateMsgWrite (HMXF_BUFFER buffer, uint64 count, MXF_ASCB_DATAREC *rec)
 
uint32 mxfASCBMsgFreshnessCounterGet (HMXF_CHANNEL channel, uint64 address, MXF_ASCB_FC *fc)
 
uint32 mxfASCBMsgFreshnessCounterSet (HMXF_CHANNEL channel, uint64 address, MXF_ASCB_FC *fc)
 
uint32 mxfASCBMsgLengthGet (HMXF_CHANNEL channel, uint64 address, uint64 *length)
 
uint32 mxfASCBMsgLengthSet (HMXF_CHANNEL channel, uint64 address, uint64 length)
 
uint32 mxfASCBMsgChecksumEnableGet (HMXF_CHANNEL channel, uint64 address, uint64 *enable)
 
uint32 mxfASCBMsgChecksumEnableSet (HMXF_CHANNEL channel, uint64 address, uint64 enable)
 
uint32 mxfASCBMsgCrcEnableGet (HMXF_CHANNEL channel, uint64 address, uint64 *enable)
 
uint32 mxfASCBMsgCrcEnableSet (HMXF_CHANNEL channel, uint64 address, uint64 enable)
 
uint32 mxfASCBRxAcqMsgSelectGet (HMXF_BUFFER buffer, uint64 maxCount, uint64 *count, MXF_MSGID_ASCB *msg)
 
uint32 mxfASCBRxAcqMsgSelectSet (HMXF_BUFFER buffer, uint64 select, uint64 maxCount, MXF_MSGID_ASCB *msg)
 
uint32 mxfASCBRxAcqRead (HMXF_BUFFER buffer, uint64 maxMsgCount, uint64 maxBytesCount, uint64 *status, uint64 *msgCount, uint64 *byteCount, MXF_ASCB_DATAREC *rec)
 
uint32 mxfASCBRxSamplingExtEnableSet (HMXF_BUFFER buffer, uint64 state, uint64 count, uint64 *address)
 
uint32 mxfASCBRxSamplingExtEnableAllGet (HMXF_BUFFER buffer, uint64 maxCount, uint64 *count, uint64 *address)
 
uint32 mxfASCBRxSamplingMsgSelectSet (HMXF_BUFFER buffer, uint64 select, uint64 count, MXF_MSGID_ASCB *msg)
 
uint32 mxfASCBRxSamplingMsgSelectGet (HMXF_BUFFER buffer, uint64 maxCount, uint64 *count, MXF_MSGID_ASCB *msg)
 
uint32 mxfASCBRxSamplingRead (HMXF_BUFFER buffer, uint64 flags, uint64 maxRecCount, uint64 maxBytesCount, uint64 *recCount, uint64 *byteCount, MXF_ASCB_SAMPREC *rec)
 
uint32 mxfASCBRxSamplingSingleRead (HMXF_BUFFER buffer, uint64 flags, uint64 address, uint64 alternate, MXF_ASCB_SAMPREC *rec)
 
uint32 mxfASCBAsyncEventRxMsgSelectSet (HMXF_ASYNCEVENT asyncEvent, HMXF_CHANNEL channel, uint64 select, uint64 count, MXF_MSGID_ASCB *msg)
 
uint32 mxfASCBAsyncEventRxMsgSelectGet (HMXF_ASYNCEVENT asyncEvent, HMXF_CHANNEL channel, uint64 maxCount, uint64 *count, MXF_MSGID_ASCB *msg)
 
uint32 mxfASCBNextDataRecordPtrGet (MXF_ASCB_DATAREC *currentRec, MXF_ASCB_DATAREC **nextRec)
 
uint32 mxfASCBNextSamplingRecordPtrGet (MXF_ASCB_SAMPREC *currentRec, MXF_ASCB_SAMPREC **nextRec)
 
uint32 mxfASCBUserBusEnableSet (HMXF_CHANNEL channel, uint64 busSide, int64 alternate, HMXF_BUFFER buffer)
 
uint32 mxfASCBUserBusEnableGet (HMXF_CHANNEL channel, uint64 busSide, int64 alternate, HMXF_BUFFER *buffer)
 
uint32 mxfASCBUserEnableSet (HMXF_CHANNEL channel, uint64 enable)
 
uint32 mxfASCBUserEnableGet (HMXF_CHANNEL channel, uint64 *enable)
 

Detailed Description

Function Documentation

uint32 mxfASCBTxPeriodicMajorFrameSet ( HMXF_CHANNEL  channel,
uint64  minorIndex,
uint64  count,
MXF_ASCB_TXPERIODIC_MJRFRAME_MSG msg 
)
C#
public static extern UInt32 mxfASCBTxPeriodicMajorFrameSet(UInt64 channel, UInt64 minorIndex, UInt64 count, MXF_ASCB_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 ASCB of the multi-protocol mxfTxPeriodicMajorFrameSet() function.
Parameters
[in]channelchannel handle.
[in]minorIndexminor frame index.
[in]countcount of messages in the minor frame.
[in]msgminor 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.4.3 and later.
See also
mxfTxPeriodicMajorFrameSet()
mxfTxPeriodicMajorFrameStart()
mxfASCBTxPeriodicMajorFrameGet()
Examples:
ascb_bc.c.
uint32 mxfASCBTxPeriodicMajorFrameGet ( HMXF_CHANNEL  channel,
uint64  minorIndex,
uint64  maxCount,
uint64 *  count,
MXF_ASCB_TXPERIODIC_MJRFRAME_MSG msg 
)
C#
public static extern UInt32 mxfASCBTxPeriodicMajorFrameGet(UInt64 channel, UInt64 minorIndex, UInt64 maxCount, out UInt64 count, out MXF_ASCB_TXPERIODIC_MJRFRAME_MSG msg);

Reads the specified minor frame of the major frame.

Note
This function is the specific version for ASCB of the multi-protocol mxfTxPeriodicMajorFrameGet() function.
Parameters
[in]channelchannel handle.
[in]minorIndexminor frame index.
[in]maxCountmaximum messages to read within the minor frame.
[out]countreturned messages count.
[out]msgminor 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.4.3 and later.
See also
mxfTxPeriodicMajorFrameGet()
mxfASCBTxPeriodicMajorFrameSet()
uint32 mxfASCBTxPeriodicUpdateMsgWrite ( HMXF_BUFFER  buffer,
uint64  count,
MXF_ASCB_DATAREC rec 
)
C#
public static extern UInt32 mxfASCBTxPeriodicUpdateMsgWrite(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 ASCB of the multi-protocol mxfTxPeriodicUpdateMsgWrite() function.
Parameters
[in]bufferbuffer handle.
[in]countcount of records to write.
[in]recarray of record(s) to write. The records in the buffer need to be indexed using mxfASCBNextDataRecordPtrGet() 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.4.3 and later.
See also
mxfTxPeriodicUpdateMsgWrite()
mxfTxPeriodicUpdateMsgBufferAlloc()
mxfTxPeriodicUpdateMsgBufferStatusGet()
mxfTxPeriodicUpdateMsgClear()
mxfASCBNextDataRecordPtrGet()
Examples:
ascb_bc.c, and ascb_user.c.
uint32 mxfASCBMsgFreshnessCounterGet ( HMXF_CHANNEL  channel,
uint64  address,
MXF_ASCB_FC fc 
)
C#
public static extern UInt32 mxfASCBMsgFreshnessCounterGet(UInt64 buffer, out MXF_ASCB_FC fc);

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

Parameters
[in]channelChannel handle.
[in]addressmessage address.
[out]fcpointer 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.4.3 and later.
See also
mxfASCBMsgFreshnessCounterSet()
uint32 mxfASCBMsgFreshnessCounterSet ( HMXF_CHANNEL  channel,
uint64  address,
MXF_ASCB_FC fc 
)
C#
public static extern UInt32 mxfASCBMsgFreshnessCounterSet(UInt64 buffer, ref MXF_ASCB_FC fc);

Sets the Freshness Counter of the specified address.

Parameters
[in]channelChannel handle.
[in]addressmessage address.
[in]fcPointer 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.4.3 and later.
See also
mxfASCBMsgFreshnessCounterGet()
Examples:
ascb_bc.c, ascb_bm.c, and ascb_user.c.
uint32 mxfASCBMsgLengthGet ( HMXF_CHANNEL  channel,
uint64  address,
uint64 *  length 
)
C#
public static extern UInt32 mxfASCBMsgLengthGet(UInt64 buffer, out UInt64 length);

This function returns the message length of the specified address.

Parameters
[in]channelChannel handle.
[in]addressmessage address.
[out]lengthpointer to returned message length.
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.3 and later.
See also
mxfASCBMsgLengthSet()
uint32 mxfASCBMsgLengthSet ( HMXF_CHANNEL  channel,
uint64  address,
uint64  length 
)
C#
public static extern UInt32 mxfASCBMsgLengthSet(UInt64 buffer, UInt64 length);

Sets the message length of the specified address.

Parameters
[in]channelChannel handle.
[in]addressmessage address.
[in]lengthmessage length.
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.3 and later.
See also
mxfASCBMsgLengthGet()
Examples:
ascb_bm.c, and ascb_user.c.
uint32 mxfASCBMsgChecksumEnableGet ( HMXF_CHANNEL  channel,
uint64  address,
uint64 *  enable 
)
C#
public static extern UInt32 mxfASCBMsgChecksumEnableGet(UInt64 channel, UInt64 address, out UInt64 enable);

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

Parameters
[in]channelchannel handle.
[in]addressmessage address.
[out]enablepointer to returned value.
Constant Description
VMXF_ENABLE Checksum enabled
VMXF_DISABLE Checksum 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.4.3 and later.
See also
mxfASCBMsgChecksumEnableSet()
uint32 mxfASCBMsgChecksumEnableSet ( HMXF_CHANNEL  channel,
uint64  address,
uint64  enable 
)
C#
public static extern UInt32 mxfASCBMsgChecksumEnableSet(UInt64 channel, UInt64 address, UInt64 enable);

Sets the data checksum of the specified message defined on a channel.

Parameters
[in]channelchannel handle.
[in]addressmessage address.
[in]enablevalue to set.
Constant Description
VMXF_ENABLE Enable checksum
VMXF_DISABLE Disable checksum
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.3 and later.
See also
mxfASCBMsgChecksumEnableGet()
Examples:
ascb_bc.c, ascb_bm.c, and ascb_user.c.
uint32 mxfASCBMsgCrcEnableGet ( HMXF_CHANNEL  channel,
uint64  address,
uint64 *  enable 
)
C#
public static extern UInt32 mxfASCBMsgCrcEnableGet(UInt64 channel, UInt64 address, out UInt64 enable);

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

Parameters
[in]channelchannel handle.
[in]addressmessage address.
[out]enablepointer 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.4.3 and later.
See also
mxfASCBMsgCrcEnableSet()
uint32 mxfASCBMsgCrcEnableSet ( HMXF_CHANNEL  channel,
uint64  address,
uint64  enable 
)
C#
public static extern UInt32 mxfASCBMsgCrcEnableSet(UInt64 channel, UInt64 address, UInt64 enable);

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

Parameters
[in]channelchannel handle.
[in]addressmessage address.
[in]enablevalue 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.4.3 and later.
See also
mxfASCBMsgCrcEnableGet()
Examples:
ascb_bc.c, ascb_bm.c, and ascb_user.c.
uint32 mxfASCBRxAcqMsgSelectGet ( HMXF_BUFFER  buffer,
uint64  maxCount,
uint64 *  count,
MXF_MSGID_ASCB *  msg 
)
C#
public static extern UInt32 mxfASCBRxAcqMsgSelectGet(UInt64 buffer, UInt64 maxCount, out UInt64 count, [Out] UInt64[] msg);

Returns the list of messages selected for acquisition.

Note
This function is the specific version for ASCB of the multi-protocol mxfRxAcqMsgSelectGet() function.
Parameters
[in]bufferbuffer handle.
[in]maxCountmaximum number of messages in the array.
[out]countreturned number of messages in the msg array.
[out]msgaddress of the returned messages 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.4.3 and later.
See also
mxfRxAcqMsgSelectGet()
mxfRxAcqBufferAlloc()
mxfRxAcqBufferGet()
mxfASCBRxAcqMsgSelectSet()
uint32 mxfASCBRxAcqMsgSelectSet ( HMXF_BUFFER  buffer,
uint64  select,
uint64  maxCount,
MXF_MSGID_ASCB *  msg 
)
C#
public static extern UInt32 mxfASCBRxAcqMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 maxCount, UInt64[] msg);

public static extern UInt32 mxfASCBRxAcqMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 maxCount, IntPtr msg);

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

Upon data arrival, the embedded process will check if the received message address is found in the current selection list. The receive data record will be added to the acquisition buffer only if the message address 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 ASCB of the multi-protocol mxfRxAcqMsgSelectSet() function.
Parameters
[in]bufferbuffer handle.
[in]selectaction to perform with the message array.
Option Description
MXF_MSG_DESELECT Deselects the message.
MXF_MSG_SELECT_ADD Adds the specified message.
MXF_MSG_SELECT_ONLY Replaces the current selection with the provided list.
[in]maxCountnumber of entries in msg.
[in]msgaddress of array of msg
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.3 and later.
See also
mxfRxAcqMsgSelectSet()
mxfRxAcqBufferAlloc()
mxfRxAcqBufferGet()
mxfASCBRxAcqMsgSelectGet()
uint32 mxfASCBRxAcqRead ( HMXF_BUFFER  buffer,
uint64  maxMsgCount,
uint64  maxBytesCount,
uint64 *  status,
uint64 *  msgCount,
uint64 *  byteCount,
MXF_ASCB_DATAREC rec 
)
C#
public static extern UInt32 mxfASCBRxAcqRead(UInt64 buffer, UInt64 maxMsgCount, UInt64 maxBytesCount, out UInt64 status, out UInt64 msgCount, out UInt64 byteCount, IntPtr rec);

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

Note
This function is the specific version for ASCB of the multi-protocol mxfRxAcqRead() function.
Parameters
[in]bufferbuffer handle.
[in]maxMsgCountmaximum number records to read (0 means all messages).
[in]maxBytesCountmaximum number of bytes to be read.
[out]statuslast status set.
[out]msgCountnumber of records returned.
[out]byteCountnumber of bytes returned.
[out]recaddress of data records. The records in the buffer need to be indexed using mxfASCBNextDataRecordPtrGet() 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.4.3 and later.
See also
mxfRxAcqRead()
mxfRxAcqStart()
mxfRxAcqBufferAlloc()
mxfRxAcqStop()
mxfASCBNextDataRecordPtrGet()
uint32 mxfASCBRxSamplingExtEnableSet ( HMXF_BUFFER  buffer,
uint64  state,
uint64  count,
uint64 *  address 
)
C#
public static extern UInt32 mxfASCBRxSamplingExtEnableSet(UInt64 buffer, UInt64 state, UInt64 count, UInt64[] address);

public static extern UInt32 mxfASCBRxSamplingExtEnableSet(UInt64 buffer, UInt64 state, UInt64 count, IntPtr address);

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

Note
count set to 0 with address set to NULL means ALL addresses.
This function is the specific version for ASCB of the multi-protocol mxfRxSamplingExtEnableSet() function.
Parameters
[in]bufferbuffer handle.
[in]stateextension filtering state.
State Description
VMXF_ENABLE Enable extension filtering.
VMXF_DISABLE Disable extension filtering.
[in]countnumber of entries in address.
[in]addressaddress of array of addresses.
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.3 and later.
See also
mxfRxSamplingExtEnableSet()
mxfASCBRxSamplingExtEnableAllGet()
uint32 mxfASCBRxSamplingExtEnableAllGet ( HMXF_BUFFER  buffer,
uint64  maxCount,
uint64 *  count,
uint64 *  address 
)
C#
public static extern UInt32 mxfASCBRxSamplingExtEnableAllGet(UInt64 buffer, UInt64 maxCount, out UInt64 count, [Out] UInt64[] address);

Returns the list of addresses that have message discrimination using the alternate enabled.

Note
This function is the specific version for ASCB of the multi-protocol mxfRxSamplingExtEnableAllGet() function.
Parameters
[in]bufferbuffer handle.
[in]maxCountmaximum number of entries in address.
[out]countnumber of entries in address.
[out]addressaddress array of addresses.
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.3 and later.
See also
mxfRxSamplingExtEnableAllGet()
mxfASCBRxSamplingExtEnableSet()
uint32 mxfASCBRxSamplingMsgSelectSet ( HMXF_BUFFER  buffer,
uint64  select,
uint64  count,
MXF_MSGID_ASCB *  msg 
)
C#
public static extern UInt32 mxfASCBRxSamplingMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 count, UInt64[] msg);

public static extern UInt32 mxfASCBRxSamplingMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 count, IntPtr msg);

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

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

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

Note
count set to 0 with labels set to NULL means ALL addresses.
This function is the specific version for ASCB of the multi-protocol mxfRxSamplingMsgSelectSet() function.
Parameters
[in]bufferbuffer handle.
[in]selectaction to perform with the message array.
Option Description
MXF_MSG_DESELECT Deselects the message(s).
MXF_MSG_SELECT_ADD Adds the specified message(s).
MXF_MSG_SELECT_ONLY Replaces the current selection with the provided list.
[in]countcount of msg in the array.
[in]msgaddress of array of messages.
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.3 and later.
See also
mxfRxSamplingMsgSelectSet()
mxfRxSamplingBufferAlloc()
mxfRxSamplingStart()
mxfASCBRxSamplingRead()
mxfASCBRxSamplingMsgSelectGet()
uint32 mxfASCBRxSamplingMsgSelectGet ( HMXF_BUFFER  buffer,
uint64  maxCount,
uint64 *  count,
MXF_MSGID_ASCB *  msg 
)
C#
public static extern UInt32 mxfASCBRxSamplingMsgSelectGet(UInt64 buffer, UInt64 maxCount, out UInt64 count, [Out] UInt64[] msg);

Returns the list of messages selected for sampling.

Note
This function is the specific version for ASCB of the multi-protocol mxfRxSamplingMsgSelectGet() function.
Parameters
[in]bufferbuffer handle.
[in]maxCountmaximum number of messages in the array msg.
[out]countreturned number of messages in the msg array.
[out]msgaddress of the returned message 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.4.3 and later.
See also
mxfRxSamplingMsgSelectGet()
mxfRxSamplingBufferAlloc()
mxfRxSamplingStart()
mxfASCBRxSamplingRead()
mxfASCBRxSamplingMsgSelectSet()
uint32 mxfASCBRxSamplingRead ( HMXF_BUFFER  buffer,
uint64  flags,
uint64  maxRecCount,
uint64  maxBytesCount,
uint64 *  recCount,
uint64 *  byteCount,
MXF_ASCB_SAMPREC rec 
)
C#
public static extern UInt32 mxfASCBRxSamplingRead(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 ASCB of the multi-protocol mxfRxSamplingRead() function.
Parameters
[in]bufferbuffer handle.
[in]flagsoption 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]maxRecCountmaximum number of messages to read (0 means all messages).
[in]maxBytesCountmaximum number of bytes to read.
[out]recCountnumber of messages returned.
[out]byteCountnumber of bytes returned.
[out]recarray of message record structure. The records in the buffer must be indexed by using mxfASCBNextSamplingRecordPtrGet() 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.4.3 and later.
See also
mxfRxSamplingRead()
mxfRxSamplingBufferAlloc()
mxfASCBRxSamplingMsgSelectSet()
mxfRxSamplingStart()
mxfASCBNextSamplingRecordPtrGet()
uint32 mxfASCBRxSamplingSingleRead ( HMXF_BUFFER  buffer,
uint64  flags,
uint64  address,
uint64  alternate,
MXF_ASCB_SAMPREC rec 
)
C#
public static extern UInt32 mxfASCBRxSamplingSingleRead(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 ASCB of the multi-protocol mxfRxSamplingSingleRead() function.
Parameters
[in]bufferbuffer handle.
[in]flagsoption 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]addressmessage address.
[in]alternatemessage alternate.
[out]recaddress 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.4.3 and later.
See also
mxfRxSamplingSingleRead()
mxfRxSamplingBufferAlloc()
mxfASCBRxSamplingMsgSelectSet()
mxfRxSamplingStart()
mxfRxSamplingStop()
uint32 mxfASCBAsyncEventRxMsgSelectSet ( HMXF_ASYNCEVENT  asyncEvent,
HMXF_CHANNEL  channel,
uint64  select,
uint64  count,
MXF_MSGID_ASCB *  msg 
)
C#
public static extern UInt32 mxfASCBAsyncEventRxMsgSelectSet(UInt64 asyncEvent, UInt64 channel, UInt64 select, UInt64 count, MXF_MSGID_ASCB[] msg);

public static extern UInt32 mxfASCBAsyncEventRxMsgSelectSet(UInt64 asyncEvent, UInt64 channel, UInt64 select, UInt64 count, IntPtr msg);

Selects or deselects the address-alternate 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 address-alternate 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 address-alternate.
This function is the specific version for ASCB of the multi-protocol mxfAsyncEventRxMsgSelectSet() function.
Parameters
[in]asyncEventasynchronous event handle.
[in]channelchannel handle.
[in]selectaction 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]countcount of messages id.
[in]msgaddress 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.4.3 and later.
See also
mxfAsyncEventRxMsgSelectSet()
mxfAsyncEventHandlerInit()
mxfASCBAsyncEventRxMsgSelectGet()
mxfAsyncEventConditionsSet()
uint32 mxfASCBAsyncEventRxMsgSelectGet ( HMXF_ASYNCEVENT  asyncEvent,
HMXF_CHANNEL  channel,
uint64  maxCount,
uint64 *  count,
MXF_MSGID_ASCB *  msg 
)
C#
public static extern UInt32 mxfASCBAsyncEventRxMsgSelectGet(UInt64 asyncEvent, UInt64 channel, UInt64 maxCount, out UInt64 count, [Out] MXF_MSGID_ASCB[] 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 ASCB of the multi-protocol mxfAsyncEventRxMsgSelectGet() function.
Parameters
[in]asyncEventasynchronous event handle.
[in]channelchannel handle.
[in]maxCountmaximum ID messages expected.
[out]countnumber of ID messages returned.
[out]msgreturned 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.4.3 and later.
See also
mxfAsyncEventRxMsgSelectGet()
mxfAsyncEventHandlerInit()
mxfASCBAsyncEventRxMsgSelectSet()
mxfAsyncEventConditionsSet()
uint32 mxfASCBNextDataRecordPtrGet ( MXF_ASCB_DATAREC currentRec,
MXF_ASCB_DATAREC **  nextRec 
)
C#
public static extern UInt32 mxfASCBNextDataRecordPtrGet(IntPtr currentRec, out IntPtr nextRec);

Returns the next buffer address in a MXF_ASCB_DATAREC buffer array.

Note
This function is the specific version for ASCB of the multi-protocol mxfNextRecordPtrGet() function.
Parameters
[in]currentRecpointer to the beginning or the current record in the buffer.
[out]nextRecpointer 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.4.3 and later.
See also
mxfNextRecordPtrGet()
mxfASCBRxAcqRead()
mxfASCBTxPeriodicUpdateMsgWrite()
mxfASCBNextSamplingRecordPtrGet()
Examples:
ascb_bm.c.
uint32 mxfASCBNextSamplingRecordPtrGet ( MXF_ASCB_SAMPREC currentRec,
MXF_ASCB_SAMPREC **  nextRec 
)
C#
public static extern UInt32 mxfASCBNextSamplingRecordPtrGet(IntPtr currentRec, out IntPtr nextRec);

Returns the next buffer address in a MXF_ASCB_SAMPREC buffer array.

Note
This function is the specific version for ASCB of the multi-protocol mxfNextRecordPtrGet() function.
Parameters
[in]currentRecpointer to the beginning or the current record in the buffer.
[out]nextRecpointer 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.4.3 and later.
See also
mxfNextRecordPtrGet()
mxfASCBRxSamplingRead()
mxfASCBNextDataRecordPtrGet()
uint32 mxfASCBUserBusEnableSet ( HMXF_CHANNEL  channel,
uint64  busSide,
int64  alternate,
HMXF_BUFFER  buffer 
)
C#
public static extern UInt32 mxfASCBUserBusEnableSet(UInt64 channel, UInt64 busSide, Int64 alternate, UInt64 buffer);

Enables or disables buses of a message on ASCB user channel and associates it to a buffer. To disable the message, use zero (0) as parameter value for buffer.

Parameters
[in]channelchannel handle.
[in]busSidebus side (0: left, 1: right).
[in]alternatespecifies which alternate on this bus (-1: no alternate, 0-3).
[in]bufferbuffer to link user message to.
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.3 and later.
See also
mxfASCBUserBusEnableGet()
mxfASCBUserEnableSet()
mxfASCBUserEnableGet()
Examples:
ascb_user.c.
uint32 mxfASCBUserBusEnableGet ( HMXF_CHANNEL  channel,
uint64  busSide,
int64  alternate,
HMXF_BUFFER *  buffer 
)
C#
public static extern UInt32 mxfASCBUserBusEnableGet(UInt64 channel, UInt64 busSide, Int64 alternate, out UInt64 buffer);

Get the buffer associated with an ASCB user channel.

Parameters
[in]channelchannel handle.
[in]busSidebus side (0: left, 1: right).
[in]alternatespecifies which alternate on this bus (-1: no alternate, 0-3).
[out]bufferbuffer user message is linked to.
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.3 and later.
See also
mxfASCBUserBusEnableSet()
mxfASCBUserEnableSet()
mxfASCBUserEnableGet()
uint32 mxfASCBUserEnableSet ( HMXF_CHANNEL  channel,
uint64  enable 
)
C#
public static extern UInt32 mxfASCBUserEnableSet(UInt64 channel, UInt64 enable);

Enables or disables ASCB user channel.

Parameters
[in]channelchannel handle.
[in]enableTRUE to enable user channel, FALSE to disable it.
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.3 and later.
See also
mxfASCBUserBusEnableSet()
mxfASCBUserBusEnableGet()
mxfASCBUserEnableGet()
Examples:
ascb_user.c.
uint32 mxfASCBUserEnableGet ( HMXF_CHANNEL  channel,
uint64 *  enable 
)
C#
public static extern UInt32 mxfASCBUserEnableGet(UInt64 channel, out UInt64 enable);

Gets enable state of an ASCB user channel.

Parameters
[in]channelchannel handle.
[out]enableTRUE when user channel is enabled, FALSE when it is 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.4.3 and later.
See also
mxfASCBUserBusEnableSet()
mxfASCBUserBusEnableGet()
mxfASCBUserEnableSet()
Updated 03/30/2022