McomControl

• See also
Reference:
McomAlloc McomInquire McomRead McomWaitPositionRequest
Availability
Not available in MIL-Lite
Available in MIL


Available on Windows
Available on Linux


Not supported on:
Not supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)
Not supported on Matrox Morphis (g)
Not supported on Matrox Morphis QxT (h)
Not supported on Matrox Orion HD (i)
Not supported on Matrox Radient eCL (j)
Not supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)
Not supported on Matrox Solios eA/XA (l)
Not supported on Matrox Solios ecl/xcl/ev-cl (m)
Not supported on Matrox USB3 Vision driver (Update 19) (o)
Not supported on Matrox RadientPro-CL (Update 7) (p)
Not supported on Matrox Radient eV-CL (Update 27 or 74) (r)
Not supported on Matrox Clarity UHD (Update 36 or 76) (u)
Not supported on Matrox GenTL driver (Update 34) (v)
Not supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)
Not supported on Matrox Concord PoE with ToE (Update 82) (z)
Not supported on Matrox Rapixo CL Pro (Update 96) (aa)
Fully supported on:
Fully supported on Host system (a)
Fully supported on Matrox Iris GTR (Update 28 or Update 68) (t)
Fully supported on Matrox Indio (Update 53 or Update 68) (w)


* Refer to the MIL system-specific information
   in the MIL Reference for the minimum update required.


For any information regarding a MIL system added during a MIL Update, see the MIL system’s release note


Not available on Non-Matrox computer
Not available on Matrox 4Sight-X
Not available on Matrox Supersight
Available on Matrox 4Sight GP/GPm
Function map
Examples
None.
McomAlloc
McomFree

Description

Parameters

ComId

Specifies the identifier of the Industrial Communication context.

ControlType

Specifies the Industrial Communication setting to control.

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

ControlValue

Specifies the 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 any type of Industrial Communication context
• For an Industrial Communication context for use with a robot controller

The following ControlType and ControlValue parameter settings can be specified for any type of Industrial Communication context:

For any type of Industrial Communication context
ControlType		Description	MIL system-specific tooltip (‡)
	ControlValue
M_COM_TIMEOUT		Sets the maximum amount of time to wait for a receiving function (for example, McomRead() or McomWaitPositionRequest()) to finish its execution. INQ (summarize) Sets the maximum amount of time to wait for a receiving function (for example, McomRead() or McomWaitPositionRequest()) to finish its execution. INQ (more details...)																					‡	a												t U28			w U53
	Value	Specifies the maximum amount of time to wait, in msecs.	‡	a												t U28			w U53

The following ControlType and ControlValue parameter settings can be specified for an Industrial Communication context used to communicate with a robot controller:

For an Industrial Communication context for use with a robot controller
ControlType		Description			MIL system-specific tooltip (‡)
	ControlValue
M_COM_REMOTE_ADDRESS		Sets the IP address of a robot controller. If an IP address was specified upon context allocation (using McomAlloc() with "IPOrName:Port"), setting this control type will overwrite that address. Changing the value of this control type will have no effect until you call McomControl() with M_COM_ROBOT_CONNECT. If the Industrial Communication context was previously connected to a robot controller, you must first disconnect it from the robot controller using McomControl() with M_COM_ROBOT_DISCONNECT. INQ (summarize) Sets the IP address of a robot controller. INQ (more details...)																							‡	a												t U28			w U53
	M_PTR_TO_DOUBLE( MIL_CONST_TEXT_PTR String )	Casts the address of the string identifying the remote address, from a MIL_CONST_TEXT_PTR to a MIL_DOUBLE. (summarize) Casts the address of the string identifying the remote address, from a MIL_CONST_TEXT_PTR to a MIL_DOUBLE. (more details...)			‡	‡	a												t U28			w U53				a												t U28			w U53
			Parameters
			String This parameter specifies the string whose address to cast.
				"n.n.n.n" Specifies the IP address of the robot controller. Express the address as a string in dotted decimal notation, where each dotted decimal value (n) is a number between 0 and 255.	‡	a												t U28			w U53
M_COM_REMOTE_PORT		Sets the port on the robot controller to use to communicate with it. If a port number was specified upon context allocation (using McomAlloc() with "IPOrName:Port"), setting this control type will overwrite that port number. Changing the value of this control type will have no effect until you call McomControl() with M_COM_ROBOT_CONNECT. If the Industrial Communication context was previously connected to a robot controller, you must first disconnect it from the robot controller using McomControl() with M_COM_ROBOT_DISCONNECT. INQ (summarize) Sets the port on the robot controller to use to communicate with it. INQ (more details...)			‡	a												t U28			w U53
	Value > 0	Specifies the port on the robot controller.			‡	a												t U28			w U53
M_COM_ROBOT_CONNECT		Connects to the robot controller. (summarize) Connects to the robot controller. (more details...)			‡	a												t U28			w U53
	M_DEFAULT	Specifies the default behavior.			‡	a												t U28			w U53
M_COM_ROBOT_CONNECT_RETRY		Sets the maximum number of times to attempt to reconnect to the robot controller. INQ (summarize) Sets the maximum number of times to attempt to reconnect to the robot controller. INQ (more details...)			‡	a												t U28			w U53
	Value	Specifies the maximum number of times to attempt to reconnect.			‡	a												t U28			w U53
M_COM_ROBOT_CONNECT_RETRY_WAIT		Sets the amount of time to wait between attempts to connect to the robot controller. INQ (summarize) Sets the amount of time to wait between attempts to connect to the robot controller. INQ (more details...)			‡	a												t U28			w U53
	Value	Specifies the amount of time to wait, in msecs.			‡	a												t U28			w U53
M_COM_ROBOT_DISCONNECT		Disconnects from the robot controller. (summarize) Disconnects from the robot controller. (more details...)			‡	a												t U28			w U53
	M_DEFAULT	Specifies the default behavior.			‡	a												t U28			w U53

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

void McomControlText (MIL_ID ComId, MIL_INT64 ControlType, MIL_CONST_TEXT_PTR ControlValue) Details Parameters ComId See ComId 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 McomControlDouble (MIL_ID ComId, MIL_INT64 ControlType, MIL_DOUBLE ControlValue) Details Parameters ComId See ComId 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.