| MIL 10 Reference
| Customize Help
| Save Settings

MdigControlFeature



See also
Availability
Available in MIL-Lite
Available in MIL

Available on Windows
Available on Linux

Not supported on:
Not supported on Host system
Not supported on Matrox CronosPlus
Not supported on Matrox GPU processing driver
Not supported on Matrox IEEE 1394 IIDC driver
Not supported on Matrox Iris GT
Not supported on Matrox Morphis
Not supported on Matrox Morphis QxT
Not supported on Matrox Orion HD
Not supported on Matrox Solios eA/XA
Not supported on Matrox Vio
Partially supported on:
Partially supported on Matrox Radient eCL
Partially supported on Matrox Solios ecl/xcl/ev-cl

Fully supported on:
Fully supported on Matrox GigE Vision driver
Fully supported on Matrox Radient eV-CXP
Fully supported on Matrox USB3 Vision driver (requires Update 19)

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

Available on Non-Matrox computer
Available on Matrox 4Sight-X
Available on Matrox 4Sight GP
Available on Matrox Supersight
function map Function map
Examples
Synopsis
Controls a feature of the camera.
Syntax
void MdigControlFeature(
MIL_ID DigId, //in
MIL_INT64 ControlType, //in
MIL_CONST_TEXT_PTR FeatureName, //in
MIL_INT64 FeatureType, //in
const void *UserVarPtr //in
)
Description

This function allows you to directly control various GenICam standard feature naming convention (SFNC) features and manufacturer-specific features of the camera. For more information, refer to the Using MIL with GenICam section of Chapter 23: Grabbing with your digitizer.

[Matrox Radient eCL; Matrox Radient eV-CL (requires Update 27); Matrox RadientPro-CL (requires Update 7); Matrox Solios ecl/xcl/ev-cl]

For Camera Link boards to work with this function, you must first configure and enable the GenICam CLProtocol module, using MdigControl() with M_GC_CLPROTOCOL. Note that this control type is only available after the required third-party vendor-supplied, standard compliant, CLProtocol library for your Camera Link camera is installed on your computer and M_GC_CLPROTOCOL_DEVICE_ID is set.

There are also two ways you can interactively control and test features of the camera and obtain results in real-time. At design-time, you can use Matrox Intellicam's Feature Browser, and depending on the type of camera/frame grabber, you can also save settings selected in the Feature Browser to the DCF. At runtime, you can launch a more limited version of this Feature Browser, using MdigControl() with M_GC_FEATURE_BROWSER; in this case, you can still test, but you cannot save your selected settings to the DCF. Both versions of the Feature Browser provide a complete list of available feature names and associated possible values, as well as code snippets with the MIL functions and MIL constants associated with your selected settings, which you can copy to your MIL application code.

To inquire a camera's manufacturer-specific feature, use MdigInquireFeature().

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 which MIL system’s documentation you should use in its place and any possible differences.
Parameters
This function is not supported on the selected boards.
This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.
Parameters
DigId

Specifies the identifier of the digitizer accessing the camera to control. This parameter must be given a valid digitizer identifier, previously allocated using MdigAlloc().

ControlType

Specifies the type of information to control for the specified feature.

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

FeatureName

Specifies the name of the camera feature to control.

function map For specifying the name of the feature
CollapseValue Description
MIL system-specific
tooltip (†)
Collapse MIL_TEXT("FeatureName") 1

Specifies the name of the feature. Note that the feature name is case-sensitive.

Refer to your camera's documentation for a list of the features available.

(summarize)
c j k m o p q r s

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

FeatureType

Specifies the data type of the feature to control.

function map For specifying the feature's type
CollapseValue Description
MIL system-specific
tooltip (†)
Collapse M_DEFAULT

Specifies to ignore this parameter.

c j k m o p q r s
Collapse M_TYPE_BOOLEAN

Specifies that the feature value is expressed as a boolean.

c j k m o p q r s
Collapse M_TYPE_COMMAND

Specifies that the feature is a command to be executed.

c j k m o p q r s
Collapse M_TYPE_DOUBLE

Specifies that the feature value is expressed as a floating-point.

c j k m o p q r s
Collapse M_TYPE_ENUMERATION

Specifies that the feature value is expressed as an enumeration.

c j k m o p q r s
Collapse M_TYPE_INT64

Specifies that the feature value is expressed as a 64-bit integer.

c j k m o p q r s
Collapse M_TYPE_REGISTER

Specifies that the feature is mapped to a multi-byte register (such as, a LUT).

c j k m o p q r s
Collapse M_TYPE_STRING

Specifies that the feature value is expressed as a string.

c j k m o p q r s
UserVarPtr
Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):
  • array of type MIL_TEXT_CHAR
  • array of type MIL_UINT8
  • M_NULL
  • MIL_BOOL
  • MIL_DOUBLE
  • MIL_INT64

Specifies the address of the variable in which to write the value of the feature.

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

The table below lists possible values for the ControlType and UserVarPtr parameters.

function map For specifying the type of information about the feature to set and the data type returned
CollapseControlType Description
MIL system-specific
tooltip (†)
UserVarPtr
Collapse M_FEATURE_EXECUTE

Sets that the specified command feature must be executed.

(summarize)
c j k m o p q r s
Collapse UserVarPtr data type info

Data type: M_NULL
Note: For when specifying a feature whose feature data type is M_TYPE_COMMAND.

c j k m o p q r s
Collapse M_FEATURE_MAX

Sets the feature it its highest possible value.

(summarize)
c j k m o p q r s
Collapse UserVarPtr data type info

Data type: M_NULL

c j k m o p q r s
Collapse M_FEATURE_MIN

Sets the feature it its lowest possible value.

(summarize)
c j k m o p q r s
Collapse UserVarPtr data type info

Data type: M_NULL

c j k m o p q r s
Collapse M_FEATURE_VALUE

Sets the current value of the feature.

(summarize)
c j k m o p q r s
Collapse UserVarPtr data type info
  • Data type: MIL_BOOL
    Note: For when specifying a feature value whose feature data type is M_TYPE_BOOLEAN.

  • Data type: MIL_DOUBLE
    Note: For when specifying a feature whose feature data type is M_TYPE_DOUBLE.

  • Data type: MIL_INT64
    Note: For when specifying a feature whose feature data type is M_TYPE_ENUMERATION or M_TYPE_INT64.

  • Data type: array of type MIL_UINT8
    Array size: MdigInquireFeature() with M_FEATURE_SIZE.
    Note: For when specifying a feature whose feature data type is M_TYPE_REGISTER. Note that, when writing the value of a register feature, the entire register must be written. That is, the size of the value written must match the register's size exactly.

  • Data type: array of type MIL_TEXT_CHAR
    Array size: MdigInquireFeature() with M_FEATURE_VALUE + M_STRING_SIZE.
    Note: For when specifying a feature whose feature data type is M_TYPE_STRING. When inquiring the size of the array using MdigInquireFeature(), the inquire will return the current string's length.

c j k m o p q r s
Collapse M_FEATURE_VALUE_AS_STRING

Sets the current value of the feature as a string.

(summarize)
c j k m o p q r s
Collapse UserVarPtr data type info

Data type: array of type MIL_TEXT_CHAR
Array size: MdigInquireFeature() with M_FEATURE_VALUE_AS_STRING + M_STRING_SIZE.
Note: When inquiring the size of the array using MdigInquireFeature(), the inquire will return the current string's length.

c j k m o p q r s
Compilation information
Header Include mil.h.
Library Use mil.lib.
DLL Requires mil.dll.
DEFAULT TYPE BOOLEAN TYPE COMMAND TYPE DOUBLE TYPE ENUMERATION TYPE INT64 TYPE REGISTER TYPE STRING FEATURE EXECUTE FEATURE MAX FEATURE MIN FEATURE VALUE FEATURE VALUE AS STRING TYPE BOOLEAN TYPE DOUBLE TYPE INT64 TYPE ENUMERATION TYPE REGISTER TYPE STRING