MobjControl

See also

User Guide:

C/C++ MILweb function reference Fundamentals for creating your MILweb client application Hosting files on a MIL HTTP server JavaScript MILweb function reference Message mailboxes Monitoring configuration

Reference:

MappControl MappOpenConnection MdigProcess MdispAlloc MdispInquire MfuncAlloc MobjAlloc MobjInquire

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

mclass.cpp
mclass.cs
mclass.vb
mdispweb.cpp
mgraweb.cpp
publishingapplication.cpp
publishingapplication.cs

Function Map

- ObjectId

Parameter Associations

Table:	For controlling the access of remote MIL objects
Table:	For controlling the access of MILweb objects
Table:	For associating a MIL object with information
Table:	For controlling message mailboxes
Table:	For controlling HTTP servers

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

Compilation information

Synopsis

Control a MIL object's settings and associate information with a MIL object.

Syntax

void MobjControl(

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

)

Description

This function controls the settings of a MIL object. You can control the read/write properties of a remote MIL object and associate information with a MIL object. You can also control MIL message mailboxes and HTTP servers.

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 controlling the access of MILweb objects
For associating a MIL object with information
For controlling message mailboxes
For controlling HTTP servers

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. This is the default value. (summarize) Specifies that the MIL object will not be visible. (more details...)
	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 control whether the object is accessible using MILweb.

For controlling the access of MILweb objects
ControlType		Description
	ControlValue	Description
M_WEB_PUBLISH		Sets whether the object is accessible using MILweb. This setting is only supported for message mailboxes and MILweb displays (allocated using MdispAlloc() with M_WEB). It is not supported for objects allocated on a DMIL remote system. This setting requires MIL driver update 47 (or later). (summarize) Sets whether the object is accessible using MILweb. (more details...)
	M_NO	Specifies that the object is not accessible using MILweb. This is the default value. (summarize) Specifies that the object is not accessible using MILweb. (more details...)
	M_READ_ONLY	Specifies that the object can be read from by a MILweb client application. A MIL object can only be set to M_READ_ONLY if M_WEB_CONNECTION is set to M_ENABLE. (summarize) Specifies that the object can be read from by a MILweb client application. (more details...)
	M_READ_WRITE	Specifies that the object can be read from and written to by a MILweb client application. A MIL object can only be set to M_READ_WRITE if M_WEB_CONNECTION is set to M_ENABLE. (summarize) Specifies that the object can be read from and written to by a MILweb client application. (more details...)

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

For associating a MIL object with information

ControlType

Description

ControlValue

M_OBJECT_NAME

Sets the name to associate with a MIL object. INQ

(summarize)

Sets the 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

Specifies the string whose address to cast.

MIL_TEXT("ObjectName") ¹

Specifies the name to associate with the MIL object.

M_OBJECT_USER_DATA_PTR

Sets the address of the user data to associate with a MIL object. This is useful, for example, to associate specific data to the different buffers passed to MdigProcess(). When used with DMIL, the user data pointer is stored locally in the process doing MobjControl. INQ

(summarize)

Sets the address of the user data to associate with a MIL object. INQ

(more details...)

M_PTR_TO_DOUBLE(

void * ptr

)

Casts the address of the specified user data, from a void * to a MIL_DOUBLE.

(summarize)

Casts the address of the specified user data, from a void * to a MIL_DOUBLE.

(more details...)

Parameters

ptr

Specifies the address of the user data.

¹ 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.

The following ControlType and corresponding ControlValue parameter settings are used to control MIL HTTP server objects allocated using MobjAlloc() with M_HTTP_SERVER.

For controlling HTTP servers

ControlType

Description

ControlValue

M_HTTP_ADDRESS

Sets the web address (URL) with which the MIL HTTP server can be accessed in a web browser.

This setting requires MIL driver update 47 (or later). INQ

(summarize)

Sets the web address (URL) with which the MIL HTTP server can be accessed in a web browser. 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

Specifies the string whose address to cast.

MIL_TEXT("http://server:port") ¹

Specifies the web address (URL). This must consist of http://, followed by the domain name or local static IP address of the local computer (for example, http://192.168.1.58 or http://VisionController42).

Optionally, you can specify the port number in the address; this must be the same as the port specified by M_HTTP_PORT. Typically, specifying the port is only useful if you have multiple HTTP server processes running on the same computer. Note that this includes third-party HTTP server software.

The default URL is "http://localhost". This web address is only accessible from a web browser running on the local computer.

M_HTTP_PORT

Sets the port on which the MIL HTTP server listens for incoming connections.

If you specified a port number using M_HTTP_ADDRESS, this must be the same port.

For increased security, you should ensure that remote computers on the internet cannot access this port of the local computer.

This setting requires MIL driver update 47 (or later). INQ

(summarize)

Sets the port on which the MIL HTTP server listens for incoming connections. INQ

(more details...)

0 <= Value <=66535

Specifies the port number.

This port must not be used by any other application (including third-party applications) running on the local computer.

The default value is 8080.

(summarize)

Specifies the port number.

(more details...)

M_HTTP_ROOT_DIRECTORY

Sets the path of the folder on the local computer in which the files hosted by the MIL HTTP server are stored (for example, HTML and JavaScript files). All files in this folder (and its subfolders) are made available to connected computers when the HTTP server is enabled (using M_HTTP_START).

You should typically ensure that there are no sensitive files in this folder (or its subfolders).

There is no default directory; you must manually set a directory before enabling the HTTP server.

This setting requires MIL driver update 47 (or later). INQ

(summarize)

Sets the path of the folder on the local computer in which the files hosted by the MIL HTTP server are stored (for example, HTML and JavaScript files). 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

Specifies the string whose address to cast.

MIL_TEXT("DirectoryName") ¹

Specifies the drive and path of the folder (for example, "C:\mydirectory").

M_HTTP_START

Enables the MIL HTTP server.

MIL HTTP servers are intended to be run on a segmented LAN that has no internet/WAN access; MIL HTTP servers offer no internal security mechanisms. When a MIL HTTP server is enabled, you should typically ensure that your network administrator configures your network to prevent incoming connections from the internet to the computer running your MIL application (and from any other devices on your network that do not need access). If this is not possible, at a minimum, you should block incoming connections from the internet to the listening port of the HTTP server. You can inquire which port is used for this purpose, using MobjInquire() with M_HTTP_PORT.

This setting requires MIL driver update 47 (or later).

(summarize)

Enables the MIL HTTP server.

(more details...)

M_HTTP_STOP

Disables the MIL HTTP server.

This setting requires MIL driver update 47 (or later).

(summarize)

Disables the MIL HTTP server.

(more details...)

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

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.