MobjControl

Filters
See also

User Guide:

Message mailboxes Monitoring configuration

Reference:

MappControl MappOpenConnection MfuncAlloc MobjAlloc

Availability

Available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

publishingapplication.cpp

Function Map

- ObjectId

Parameter Associations

Table:	For controlling the access of remote MIL objects
Table:	For associating a name to a MIL object
Table:	For controlling message mailboxes

Type specific versions of the function when using a C compiler under 64-bit

Compilation information

Synopsis

Control a MIL object setting for a Distributed MIL publishing application.

Syntax

void MobjControl(

MIL_ID ObjectId,	//in
MIL_INT64 ControlType,	//in
MIL_DOUBLE ControlValue	//in

)

Description

This function controls settings for the MIL objects in a publishing application within the Distributed MIL monitoring configuration. You can set the read/write access and the name of each MIL object on the specified application.

Note that when using a C compiler (not a C++ or other compiler) in 64-bit mode, MobjControl() internally calls the MIL_DOUBLE version of this function (MobjControlDouble()). If you need to pass integer values, call the MIL_INT64 version of this function (MobjControlInt64()).

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see if there is complementary information.

Parameters

This function is not supported on the selected boards.

Parameters

ObjectId

Specifies the identifier of the MIL object to control. The MIL object can be a MIL utility object (allocated using MobjAlloc()) or any other MIL object, except for MIL objects allocated using MfuncAlloc().

ControlType

Specifies the type of MIL object setting to control.

See the Parameter associations section for possible values that can be specified.

ControlValue

Specifies the MIL object setting's new value.

See the Parameter associations section for possible values that can be specified.

Parameter associations

The tables below list possible values for the ControlType and ControlValue parameters.

For controlling the access of remote MIL objects
For associating a name to a MIL object
For controlling message mailboxes

The following ControlType and corresponding ControlValue parameter settings are used to control the access of remote MIL objects.

For controlling the access of remote MIL objects
ControlType		Description
	ControlValue	Description
M_DMIL_PUBLISH		Controls a MIL object's remote access rights. If you set a MIL object to M_READ_ONLY or M_READ_WRITE, a monitoring application will be able to access that MIL object once a connection has been established MappOpenConnection() between the monitoring and publishing applications. Note that the access rights of all MIL objects in a given publishing application cannot be greater than that application's permission level specified in MappControl() with M_DMIL_CONNECTION. INQ (summarize) Controls a MIL object's remote access rights. INQ (more details...)
	M_NO	Specifies that the MIL object will not be visible.
	M_READ_ONLY	Specifies that the MIL object can only be used as a source or to be inquired. A MIL object can only be set to M_READ_ONLY if M_DMIL_CONNECTION is set to either M_DMIL_CONTROL or M_DMIL_MONITOR. (summarize) Specifies that the MIL object can only be used as a source or to be inquired. (more details...)
	M_READ_WRITE	Specifies that the MIL object can be used as a destination or can be controlled by MIL functions. A MIL object can only be set to M_READ_WRITE if M_DMIL_CONNECTION is set to M_DMIL_CONTROL. (summarize) Specifies that the MIL object can be used as a destination or can be controlled by MIL functions. (more details...)

The following ControlType and corresponding ControlValue parameter settings are used to associate a name to a MIL object.

For associating a name to a MIL object

ControlType

Description

ControlValue

M_OBJECT_NAME

Specifies a name to associate with a MIL object. INQ

(summarize)

Specifies a name to associate with a MIL object. INQ

(more details...)

M_PTR_TO_DOUBLE(

MIL_CONST_TEXT_PTR * String

)

Casts the address of the string identifying the specified object's name, from a MIL_CONST_TEXT_PTR to a MIL_DOUBLE.

(summarize)

Casts the address of the string identifying the specified object's name, from a MIL_CONST_TEXT_PTR to a MIL_DOUBLE.

(more details...)

Parameters

String

This parameter specifies the string whose address to cast.

MIL_TEXT("ObjectName") ¹

Specifies the name to associate with the MIL object.

¹ If you are passing the value in a variable, don't enclose it in MIL_TEXT().

The following ControlType and corresponding ControlValue parameter settings are used to control message mailbox objects allocated using MobjAlloc() with M_MESSAGE_MAILBOX.

For controlling message mailboxes
ControlType		Description
	ControlValue	Description
M_QUEUE_FULL_MODE		Sets the behavior of the queue when the message limit is attained. INQ (summarize) Sets the behavior of the queue when the message limit is attained. INQ (more details...)
	M_DEFAULT	Same as M_WRITE_TIMEOUT.
	M_ERROR	Specifies that a MIL error is generated when the message limit is attained.
	M_WRITE_TIMEOUT	Specifies to wait for the write timeout to elapse.
M_QUEUE_SIZE		Sets the number of messages the queue can hold. INQ (summarize) Sets the number of messages the queue can hold. INQ (more details...)
	M_DEFAULT	Specifies the default value; the default value is 100 messages.
	Value > 0	Specifies the number of messages the queue can hold.
M_READ_TIMEOUT		Sets the amount of time to wait for a read operation. INQ (summarize) Sets the amount of time to wait for a read operation. INQ (more details...)
	M_DEFAULT	Same as M_INFINITE.
	M_INFINITE	Specifies that the read operation waits indefinitely.
	Value > 0	Specifies the amount of time to wait, in msecs.
M_RESET		Resets the message mailbox by removing all messages. (summarize) Resets the message mailbox by removing all messages. (more details...)
	M_DEFAULT	Specifies the default behavior.
M_WRITE_TIMEOUT		Sets the amount of time to wait for a write operation. INQ (summarize) Sets the amount of time to wait for a write operation. INQ (more details...)
	M_DEFAULT	Same as M_INFINITE.
	M_INFINITE	Specifies that the write operation waits indefinitely.
	Value > 0	Specifies the amount of time to wait, in msecs.

Type specific versions of the function when using a C compiler under 64-bit

void MobjControlDouble (MIL_ID ObjectId, MIL_INT64 ControlType, MIL_DOUBLE ControlValue)

Details

Parameters

ObjectId

See ObjectId of the main function for a description.

ControlType

See ControlType of the main function for a description.

ControlValue

See ControlValue of the main function for a description.

void MobjControlInt64 (MIL_ID ObjectId, MIL_INT64 ControlType, MIL_INT64 ControlValue)

Details

Parameters

ObjectId

See ObjectId of the main function for a description.

ControlType

See ControlType of the main function for a description.

ControlValue

See ControlValue of the main function for a description.

Compilation information

Header	Include mil.h.
Library	Use mil.lib.
DLL	Requires mil.dll.