MdigInquireFeature
- See also
Availability
Function map
- Examples
MdigInquire
- MdigProcess
- array of type MIL_TEXT_CHAR [optionally, in C++: a reference to a MIL_STRING]
- array of type MIL_UINT8 [optionally, in C++: a reference to a std::vector<MIL_UINT8> ]
- MIL_BOOL
- MIL_DOUBLE
- MIL_INT
- MIL_INT64
-
Data type: address of a MIL_INT64
-
Data type: address of a MIL_INT64
-
To learn whether the specified feature is available, use the M_FEATURE_IS_AVAILABLE macro. Note that if a feature is not available, use M_FEATURE_IS_IMPLEMENTED to learn whether the specified feature is only temporarily unavailable or actually not implemented on your camera. A feature that is temporarily unavailable typically relies on the setting of another feature (for example, when a trigger feature is set to off, its associated trigger polarity feature would be unavailable).
-
To learn whether the specified feature is implemented, use the M_FEATURE_IS_IMPLEMENTED macro.
For example, a Bayer color feature would not be implemented on a monochrome camera because the hardware cannot support it.
-
To learn whether the specified feature can be read, use the M_FEATURE_IS_READABLE macro.
-
To learn whether the specified feature can be written to, use the M_FEATURE_IS_WRITABLE macro.
-
Data type: address of a MIL_INT64
-
Data type: address of a MIL_INT64
-
Data type: address of a MIL_INT
-
Data type: address of a MIL_INT
-
Data type: address of a MIL_INT64
-
Data type: address of a MIL_INT64
-
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_FEATURE_DESCRIPTION + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_FEATURE_DESCRIPTION + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_FEATURE_DISPLAY_NAME + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_FEATURE_DISPLAY_NAME + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: address of a MIL_BOOL
-
Data type: address of a MIL_BOOL
-
Data type: address of a MIL_INT64
-
Data type: address of a MIL_INT64
-
Data type: address of a MIL_DOUBLE
Note: For when inquiring a feature whose feature data type is a double-precision floating-point; set UserVarType to M_TYPE_DOUBLE. -
Data type: address of a MIL_INT64
Note: For when inquiring a feature whose feature data type is a 64-bit integer; set UserVarType to M_TYPE_INT64. -
Data type: address of a MIL_DOUBLE
Note: For when inquiring a feature whose feature data type is a double-precision floating-point; set UserVarType to M_TYPE_DOUBLE. -
Data type: address of a MIL_INT64
Note: For when inquiring a feature whose feature data type is a 64-bit integer; set UserVarType to M_TYPE_INT64. -
Data type: address of a MIL_DOUBLE
Note: For when inquiring a feature whose feature data type is a double-precision floating-point; set UserVarType to M_TYPE_DOUBLE. -
Data type: address of a MIL_INT64
Note: For when inquiring a feature whose feature data type is a 64-bit integer; set UserVarType to M_TYPE_INT64. -
Data type: address of a MIL_DOUBLE
Note: For when inquiring a feature whose feature data type is a double-precision floating-point; set UserVarType to M_TYPE_DOUBLE. -
Data type: address of a MIL_INT64
Note: For when inquiring a feature whose feature data type is a 64-bit integer; set UserVarType to M_TYPE_INT64. -
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_FEATURE_NAME + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_FEATURE_NAME + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: address of a MIL_INT64
-
Data type: address of a MIL_INT64
-
Data type: address of a MIL_BOOL
-
Data type: address of a MIL_BOOL
-
Data type: address of a MIL_INT64
-
Data type: address of a MIL_INT64
-
Data type: address of a MIL_INT
-
Data type: address of a MIL_INT
-
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_FEATURE_SELECTOR_NAME + n + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_FEATURE_SELECTOR_NAME + n + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: address of a MIL_INT
-
Data type: address of a MIL_INT
-
Data type: address of a MIL_INT64
-
Data type: address of a MIL_INT64
-
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_FEATURE_TOOLTIP + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_FEATURE_TOOLTIP + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: address of a MIL_INT64
-
Data type: address of a MIL_INT64
-
Data type: address of a MIL_BOOL
Note: For when inquiring a feature's value whose feature data type is a boolean; set UserVarType to M_TYPE_BOOLEAN. -
Data type: address of a MIL_DOUBLE
Note: For when inquiring a feature's value whose feature data type is a double-precision floating-point; set UserVarType to M_TYPE_DOUBLE. -
Data type: address of a MIL_INT64
Note: For when inquiring a feature's value whose feature data type is a 64-bit integer; set UserVarType to M_TYPE_INT64. -
Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a std::vector<MIL_UINT8> ]
Required array size: MdigInquireFeature ( M_TYPE_STRING + M_FEATURE_USER_ARRAY_SIZE() )
Note: For when inquiring a feature's value whose feature data type is a multi-byte register set UserVarType to M_TYPE_UINT8 + M_FEATURE_USER_ARRAY_SIZE(). -
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_TYPE_STRING + M_FEATURE_USER_ARRAY_SIZE() )
Note: For when inquiring a feature's value whose feature data type is a string; set UserVarType to M_TYPE_STRING + M_FEATURE_USER_ARRAY_SIZE().
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: address of a MIL_BOOL
Note: For when inquiring a feature's value whose feature data type is a boolean; set UserVarType to M_TYPE_BOOLEAN. -
Data type: address of a MIL_DOUBLE
Note: For when inquiring a feature's value whose feature data type is a double-precision floating-point; set UserVarType to M_TYPE_DOUBLE. -
Data type: address of a MIL_INT64
Note: For when inquiring a feature's value whose feature data type is a 64-bit integer; set UserVarType to M_TYPE_INT64. -
Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a std::vector<MIL_UINT8> ]
Required array size: MdigInquireFeature ( M_TYPE_STRING + M_FEATURE_USER_ARRAY_SIZE() )
Note: For when inquiring a feature's value whose feature data type is a multi-byte register set UserVarType to M_TYPE_UINT8 + M_FEATURE_USER_ARRAY_SIZE(). -
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_TYPE_STRING + M_FEATURE_USER_ARRAY_SIZE() )
Note: For when inquiring a feature's value whose feature data type is a string; set UserVarType to M_TYPE_STRING + M_FEATURE_USER_ARRAY_SIZE().
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: address of a MIL_INT64
-
Data type: address of a MIL_INT64
-
Data type: address of a MIL_INT64
-
Data type: address of a MIL_INT64
-
To learn whether the specified enumeration entry is available, use the M_FEATURE_IS_AVAILABLE macro. Note that if an enumeration entry is not available, use M_FEATURE_IS_IMPLEMENTED to learn whether the specified enumeration entry is only temporarily unavailable or actually not implemented on your camera. An enumeration entry that is temporarily unavailable typically relies on the setting of another feature or enumeration entry.
-
To learn whether the specified enumeration entry is implemented, use the M_FEATURE_IS_IMPLEMENTED macro.
-
To learn whether the specified enumeration entry can be read, use the M_FEATURE_IS_READABLE macro.
-
Data type: address of a MIL_INT
-
Data type: address of a MIL_INT
-
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_FEATURE_ENUM_ENTRY_DESCRIPTION + n + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_FEATURE_ENUM_ENTRY_DESCRIPTION + n + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_FEATURE_ENUM_ENTRY_DISPLAY_NAME + n + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_FEATURE_ENUM_ENTRY_DISPLAY_NAME + n + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_FEATURE_ENUM_ENTRY_NAME + n + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_FEATURE_ENUM_ENTRY_NAME + n + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_FEATURE_ENUM_ENTRY_TOOLTIP + n + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_FEATURE_ENUM_ENTRY_TOOLTIP + n + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: address of a MIL_INT64
-
Data type: address of a MIL_INT64
-
Data type: address of a MIL_INT64
-
Data type: address of a MIL_INT64
-
Data type: address of a MIL_INT
-
Data type: address of a MIL_INT
-
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_SUBFEATURE_NAME + n + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
Required array size: MdigInquireFeature ( M_SUBFEATURE_NAME + n + M_STRING_SIZE )
Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. -
Data type: address of a MIL_INT64
-
Data type: address of a MIL_INT64
-
Data type: address of a MIL_DOUBLE
-
Data type: address of a MIL_DOUBLE
in the MIL Reference for the minimum update required.
| Table: | For specifying the UserVarPtr's data type |
| + combination: | For specifying the length of the array |
| MIL_ID DigId, | //in |
| MIL_INT64 InquireType, | //in |
| MIL_CONST_TEXT_PTR FeatureName, | //in |
| MIL_INT64 UserVarType, | //in |
| void *UserVarPtr | //out |
DescriptionThis function allows you to directly inquire various GenICam standard feature naming convention (SFNC) features and manufacturer-specific features of the camera. When used with a GenICam SFNC-compliant camera, it allows you to directly inquire various manufacture-specific features specified with the camera's device description file (XML). Note that for the purpose of this function, a feature can also be of type category or command. Although category and command features lack a feature value, all other attributes of the feature can be inquired. For a list of standard category feature names, see the Standard Feature Naming Convention or your GenICam SFNC-compliant camera's documentation.
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. For more information, refer to the Using MIL with GenICam section of Chapter 25: Grabbing with your digitizer.
The features described in this function are primarily available to check existing settings using MIL code or to retrieve information from which you can build your own interface for the camera device's description file (XML). MIL provides two versions of an interface that you can use to interactively inquire the camera's features. At design-time, you can use Matrox Intellicam's Feature Browser. At runtime, you can launch Matrox Feature Browser, using MdigControl() with M_GC_FEATURE_BROWSER. Both versions of Matrox Feature Browser provide a list of available feature names and associated possible values, as well as code snippets with the MIL functions and MIL constants associated with the settings selected; you can copy the code snippets to your MIL application code.
Occasionally, the returned information is a string whose length can change between when you inquires its size and when you inquire its value (for example, the temperature can change from 99 to 100 between calls). In this case, when you inquire the information's length to allocate an array of an appropriate size, you might allocate an array that is too small to retrieve the data and experience an application crash. To avoid an application crash, specify the length of the array passed to the UserVarPtr parameter using the M_FEATURE_USER_ARRAY_SIZE() macro; the data will be truncated to fit in the array and an error will be generated.
To control a camera's manufacturer-specific feature, use MdigControlFeature().
ParametersSpecifies the identifier of the digitizer accessing the camera to inquire. This parameter must be given a valid digitizer identifier, previously allocated using MdigAlloc().
Specifies the data type of the variable in which to return the requested information (pointed to by the UserVarPtr parameter).
See the Parameter associations section for possible values that can be specified.
Specifies the name of the camera feature to inquire. Note that this parameter expects a case-sensitive string.
|
For specifying the name of the feature |
|||||||||||||||||||||||||||||||||||||||
| Value |
Description |
MIL system-specific tooltip (‡) |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
||||||||||||||||||
|
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)Specifies the name of the feature. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| MIL_TEXT("Root") 1 |
Specifies to inquire the highest-level feature of the XML structure; this feature is of type category and typically, its subfeatures are also of type category. Note that this value is only available when using M_SUBFEATURE_.... (summarize)Specifies to inquire the highest-level feature of the XML structure; this feature is of type category and typically, its subfeatures are also of type category. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
1 If you are passing the value in a variable, don't enclose it in MIL_TEXT().
Specifies the data type of the address pointed to by the UserVarPtr parameter. If not inquiring the feature's value (using M_FEATURE_VALUE), set this parameter to M_DEFAULT.
Note that, in the case of a string (or a multi-byte register), the size of the array passed to the UserVarPtr parameter must be equal to or larger than the returned information; otherwise an application crash will occur.
|
For specifying the UserVarPtr's data
type |
|||||||||||||||||||||||||||||||||||||||
| Value |
Description |
MIL system-specific tooltip (‡) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||||||||||||||||||
| M_TYPE_BOOLEAN |
Specifies that UserVarPtr is passed an address of type MIL_BOOL. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_TYPE_DOUBLE |
Specifies that UserVarPtr is passed an address of type MIL_DOUBLE. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_TYPE_INT64 |
Specifies that UserVarPtr is passed an address of type MIL_DOUBLE. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_TYPE_STRING + |
Specifies that UserVarPtr is passed an address of type MIL_TEXT_CHAR. You must specify a combination value from the following table: Specifies that UserVarPtr is passed an address of type MIL_TEXT_CHAR. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_TYPE_UINT8 + |
Specifies that UserVarPtr is passed an address of type MIL_UINT8. You must specify a combination value from the following table: Specifies that UserVarPtr is passed an address of type MIL_UINT8. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
You must add the following value to the above-mentioned values to specify the length of the array.
|
For specifying the length of the array
|
||||||||||||||||||||||||||||||||||||||||||
| Combination
value |
Description |
MIL system-specific tooltip (‡) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|||||||||||||||||||||
|
|
Specifies the length of the array. (summarize)Specifies the length of the array. (more details...) |
‡ | ‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||
| Parameters | ||||||||||||||||||||||||||||||||||||||||||
|
Sets the length, in bytes. |
||||||||||||||||||||||||||||||||||||||||||
Specifies the address of the variable in which to return the requested information.
See the Parameter associations section for possible values that can be returned.
The tables below list possible values for the InquireType parameter and possible values returned to the UserVarPtr parameter.
The following inquire types are used to specify the type of information about the feature to inquire and the data type returned.
|
For specifying the type of information to inquire
about the feature and the data type returned
|
|||||||||||||||||||||||||||||||||||||||
|
|
Description | MIL system-specific tooltip (‡) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||||||||||||||||||
|
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
| M_FEATURE_ACCESS_MODE
+ |
Inquires whether the specified feature is implemented, available, readable, and/or writable. Note that an error is generated if the feature does not exist in the camera's device description file (XML). To learn if the specified feature exists in the file and is implemented on your camera, use M_FEATURE_PRESENT. (summarize)Inquires whether the specified feature is implemented, available, readable, and/or writable. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
  UserVarPtr extra info |
Data type info: Data
type: address of a
MIL_INT64
Data type info: Data
type: address of a
MIL_INT64
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
 Bit-encoded access mode
value |
Specifies a bit-encoded value that details the access mode. To establish the access mode from the encoded value, use the following macros: Specifies a bit-encoded value that details the access mode. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FEATURE_CACHING_MODE
+ |
Inquires whether a copy of the specified feature's value is stored in Host memory for faster access and retrieval. If so, the feature is known as a cachable feature. A cachable feature is typically only retrieved from the camera whenever the cache is invalidated (such as, before the first read and before the first read to occur after a write operation). A cachable feature is typically a value that only changes based on user-interaction (setting a control value). For example, a temperature feature is not cachable. To return a true/false value for this inquire, use the M_FEATURE_IS_CACHABLE macro on the returned result. (summarize)Inquires whether a copy of the specified feature's value is stored in Host memory for faster access and retrieval. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr extra info |
Data type info: Data
type: address of a
MIL_INT64
Data type info: Data
type: address of a
MIL_INT64
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_FEATURE_CACHING_MODE_NONE |
Specifies that the feature is not cachable. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_FEATURE_CACHING_MODE_WRITE_AROUND |
Specifies that feature's values are written only to the camera, and the cache is updated the next time the feature's value is inquired. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_FEATURE_CACHING_MODE_WRITE_THROUGH |
Specifies that when information is written to the camera, the cache is updated simultaneously. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FEATURE_CHANGE_HOOK
+ |
Inquires whether an event occurs when the value of a feature changes. If enabled, MbufHookFunction() with M_FEATURE_CHANGE hooks a specified function to the feature change event. To retrieve the name of the feature that caused the event, use MbufGetHookInfo() with M_GC_FEATURE_CHANGE_NAME within the hook function. (summarize)Inquires whether an event occurs when the value of a feature changes. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
Data type info: Data
type: address of a MIL_INT
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_DISABLE |
Specifies that no event is generated when the value of the specified feature changes. This is the default value. (summarize)Specifies that no event is generated when the value of the specified feature changes. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_ENABLE |
Specifies that an event is generated when the value of the specified feature changes. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FEATURE_DEPRECATED
+ |
Inquires whether the specified feature is deprecated and should no longer be used. (summarize)Inquires whether the specified feature is deprecated and should no longer be used. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr extra info |
Data type info: Data
type: address of a
MIL_INT64
Data type info: Data
type: address of a
MIL_INT64
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FALSE |
Specifies that the feature is not depreciated. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_TRUE |
Specifies that the feature is depreciated. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FEATURE_DESCRIPTION
+ |
Inquires the description of the specified feature. (summarize)Inquires the description of the specified feature. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr extra info |
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| Value |
Specifies the description of the feature. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FEATURE_DISPLAY_NAME
+ |
Inquires the specified feature's display name. Note that this can differ slightly from the internally-used feature name (M_FEATURE_NAME). (summarize)Inquires the specified feature's display name. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr extra info |
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| Value |
Specifies the display name of the feature. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FEATURE_EXECUTE_COMPLETED + |
Inquires whether the specified executable camera feature (command) has finished executing on your camera. Note that to enable command execution-completion polling, set MsysControl() with M_GC_FEATURE_EXECUTE_POLLING_MODE to M_AUTOMATIC. (summarize)Inquires whether the specified executable camera feature (command) has finished executing on your camera. (more details...) |
‡ | c U25 |
v | |||||||||||||||||||||||||||||||||||
| UserVarPtr extra info |
Data type info: Data
type: address of a MIL_BOOL
Data type info: Data
type: address of a MIL_BOOL
|
‡ | c U25 |
v | |||||||||||||||||||||||||||||||||||
| M_FALSE |
Specifies that the executable camera feature has not finished executing. |
‡ | c U25 |
v | |||||||||||||||||||||||||||||||||||
| M_TRUE |
Specifies that the executable camera feature has finished executing. |
‡ | c U25 |
v | |||||||||||||||||||||||||||||||||||
| M_FEATURE_INCREMENT
+ |
Inquires the value by which the feature's value increments. For example, if a feature's possible values are 2, 4, 6, ..., then the feature's value increments by 2. (summarize)Inquires the value by which the feature's value increments. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr extra info |
Data type info: Data
type: address of a
MIL_INT64
Data type info: Data
type: address of a
MIL_INT64
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| Value |
Specifies the feature's incremental value. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FEATURE_MAX
+ |
Inquires the maximum possible value for the feature. (summarize)Inquires the maximum possible value for the feature. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr
extra info |
Data type info: Data
type: address of a MIL_DOUBLE
| address of a
MIL_INT64 MORE
Data type info: Data
type: address of a MIL_DOUBLE
| address of a
MIL_INT64 MORE
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| Value |
Specifies the maximum possible value for the feature. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FEATURE_MIN
+ |
Inquires the minimum possible value for the feature. (summarize)Inquires the minimum possible value for the feature. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr
extra info |
Data type info: Data
type: address of a MIL_DOUBLE
| address of a
MIL_INT64 MORE
Data type info: Data
type: address of a MIL_DOUBLE
| address of a
MIL_INT64 MORE
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| Value |
Specifies the maximum possible value for the feature. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FEATURE_NAME
+ |
Inquires the specified internally-used feature name. Note that this can differ slightly from the displayed name of the feature (M_FEATURE_DISPLAY_NAME). (summarize)Inquires the specified internally-used feature name. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr
extra info |
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| Value |
Specifies the feature's name. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FEATURE_POLLING_INTERVAL + |
Inquires the interval between inquiring an executable feature's completion status, when automatically polling (using MsysControl() with M_GC_FEATURE_EXECUTE_POLLING_MODE). (summarize)Inquires the interval between inquiring an executable feature's completion status, when automatically polling (using MsysControl() with M_GC_FEATURE_EXECUTE_POLLING_MODE). (more details...) |
‡ | c U25 |
v | |||||||||||||||||||||||||||||||||||
| UserVarPtr extra info |
Data type info: Data
type: address of a
MIL_INT64
Data type info: Data
type: address of a
MIL_INT64
|
‡ | c U25 |
v | |||||||||||||||||||||||||||||||||||
|
Value >= -1 |
Specifies the polling interval, in msecs. |
‡ | c U25 |
v | |||||||||||||||||||||||||||||||||||
| M_FEATURE_PRESENT
+ |
Inquires whether the specified feature is present in the camera's device description file. Note that, if the feature is listed in the camera's device description file (XML), use M_FEATURE_ACCESS_MODE and the M_FEATURE_IS_IMPLEMENTED macro to determine if the feature is supported. If the feature is not present in the file, M_FEATURE_PRESENT will return M_NO, whereas M_FEATURE_ACCESS_MODE will generate an error. (summarize)Inquires whether the specified feature is present in the camera's device description file. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr extra info |
Data type info: Data
type: address of a MIL_BOOL
Data type info: Data
type: address of a MIL_BOOL
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_NO |
Specifies that the specified feature is not present. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_YES |
Specifies that the specified feature is present. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FEATURE_REPRESENTATION + |
Inquires the display format for the feature's value. The display format dictates the size of the field and its form (for example, check box, slider, text-box) used in a user-interface for the camera's device description file (XML), such as Matrox Feature Browser (accessible through Matrox Intellicam or MdigControl() with M_GC_FEATURE_BROWSER). Note that this inquire type can only be used with a feature that has a data type of MIL_INT64 or MIL_DOUBLE. (summarize)Inquires the display format for the feature's value. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr extra info |
Data type info: Data
type: address of a
MIL_INT64
Data type info: Data
type: address of a
MIL_INT64
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_FEATURE_REPRESENTATION_BOOLEAN |
Specifies that the feature should be displayed as a checkbox. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_FEATURE_REPRESENTATION_HEX_NUMBER |
Specifies that the feature should be displayed as a hexadecimal value. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_FEATURE_REPRESENTATION_IPV4_ADDRESS |
Specifies that the feature should be displayed as an IP address in dotted decimal notation. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_FEATURE_REPRESENTATION_LINEAR |
Specifies that the feature should be displayed as a slider with the appropriate range shown. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_FEATURE_REPRESENTATION_LOGARITHMIC |
Specifies that the feature should be displayed as a slider with the appropriate logarithmic range shown. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_FEATURE_REPRESENTATION_MAC_ADDRESS |
Specifies that the feature should be displayed as a hexadecimal MAC address. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_FEATURE_REPRESENTATION_PURE_NUMBER |
Specifies that the feature should be displayed as edit text-box with a decimal display. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FEATURE_SELECTOR_COUNT + |
Inquires the number of selectors that are ancestors of the feature. Selectors take an enumerator or integer to index which instance of a subfeature should be accessed, when multiple instances of a subfeature exist. For example, the GenICam standard TriggerSelector feature is used to select which type of trigger to configure ( for example, FrameStart and AcquisitionStart are both enumerators that can be passed to TriggerSelector). All subfeatures of the selector (such as its source) are referenced from the trigger selector (TriggerSource[AcquisitionStart]). This inquire type only returns a value greater than 0 if the feature is a subfeature of a selector. It returns 1 if the feature is a subfeature of a selector. It returns 2 if its selector is also referenced by another selector. The M_FEATURE_SELECTOR_COUNT for TriggerMode, in this example, would be 1. To inquires the name of the selector associated with the specified feature, use M_FEATURE_SELECTOR_NAME + n. (summarize)Inquires the number of selectors that are ancestors of the feature. (more details...) |
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
| UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
Data type info: Data
type: address of a MIL_INT
|
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
| Value |
Specifies the number of ancestor selectors of the feature. |
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
| M_FEATURE_SELECTOR_NAME +
n + |
Inquires the name of the ancestor selector of the specified subfeature, where n is the number of generations. So, if inquiring the feature selector name of the 1st selector of TriggerSource, the returned name would be TriggerSelector. To inquires the number of selectors that are associated with the specified feature, use M_FEATURE_SELECTOR_COUNT. (summarize)Inquires the name of the ancestor selector of the specified subfeature, where n is the number of generations. (more details...) |
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
| UserVarPtr extra info |
|
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
| Value |
Specifies the name associated with the selector index. |
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
| M_FEATURE_SIZE
+ |
Inquires the size of the feature's value. (summarize)Inquires the size of the feature's value. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr
extra info |
Data type info:
Data type: address of a
MIL_INT
Data type info:
Data type: address of a
MIL_INT
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| Value |
Specifies the feature's size, in bytes. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FEATURE_STREAMABLE
+ |
Inquires whether the specified feature is streamable. A streamable feature can be stored in the local camera's description file (an XML file stored on your computer). Streamable features are typically not persistent values (such as pixel format and image size). In most cases, a streamable feature is capable of being saved and loaded from file at a later date, possibly on a different camera. (summarize)Inquires whether the specified feature is streamable. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr extra info |
Data type info:
Data type: address of a
MIL_INT64
Data type info:
Data type: address of a
MIL_INT64
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FALSE |
Specifies that the feature is not streamable. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_TRUE |
Specifies that the feature is streamable. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FEATURE_TOOLTIP
+ |
Inquires the tooltip of the specified feature. (summarize)Inquires the tooltip of the specified feature. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr extra info |
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| Value |
Specifies the feature's tooltip. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FEATURE_TYPE
+ |
Inquires the specified feature's type. (summarize)Inquires the specified feature's type. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr
extra info |
Data type info:
Data type: address of a
MIL_INT64
Data type info:
Data type: address of a
MIL_INT64
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_TYPE_BOOLEAN |
Specifies that the feature's value is a boolean. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_TYPE_CATEGORY |
Specifies that the feature is a category feature, and its value cannot be inquired. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_TYPE_COMMAND |
Specifies that the feature is a command and its value cannot be inquired. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_TYPE_DOUBLE |
Specifies that the feature's value is a floating-point. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_TYPE_ENUMERATION |
Specifies that the feature's value is an enumeration. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_TYPE_INT64 |
Specifies that the feature's value is a 64-bit integer. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_TYPE_REGISTER |
Specifies that the feature's value is mapped to a multi-byte register. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_TYPE_STRING |
Specifies that the feature's value is a string. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FEATURE_VALUE
+ |
Inquires the current value of the feature. (summarize)Inquires the current value of the feature. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr extra info |
Data type info:
Data type: address of a
MIL_BOOL | address of a
MIL_DOUBLE | address of a
MIL_INT64 | array of type
MIL_UINT8 [optionally, in C++: a reference to a std::vector<MIL_UINT8>
] | array of type
MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
MORE
Data type info:
Data type: address of a
MIL_BOOL | address of a
MIL_DOUBLE | address of a
MIL_INT64 | array of type
MIL_UINT8 [optionally, in C++: a reference to a std::vector<MIL_UINT8>
] | array of type
MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ]
MORE
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| Value |
Specifies the feature's value. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FEATURE_VISIBILITY
+ |
Inquires the visibility level of the specified feature. The visibility level indicates the level of expertise required to view or select the feature. When creating a custom user interface for the camera's device description file (XML), the visibility level of the specified feature can be used to potentially hide the specified feature. The current level of visibility should be set within your custom user-interface, and the enumeration entry for the visibility level of the specified feature must be compared against it. If the specified enumeration entry has a level of visibility higher than the current level of visibility, it is hidden. (summarize)Inquires the visibility level of the specified feature. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr extra info |
Data type info:
Data type: address of a
MIL_INT64
Data type info:
Data type: address of a
MIL_INT64
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_FEATURE_VISIBILITY_BEGINNER |
Specifies that the feature is suggested for beginners. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_FEATURE_VISIBILITY_EXPERT |
Specifies that the feature is suggested for experts. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_FEATURE_VISIBILITY_GURU |
Specifies that the feature is suggested for advanced experts. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_FEATURE_VISIBILITY_INVISIBLE |
Specifies that the feature should not be shown in the user-interface for the camera's device description file (XML). Note that an invisible feature can still be set or inquired using MdigControlFeature() and MdigInquireFeature(), respectively. (summarize)Specifies that the feature should not be shown in the user-interface for the camera's device description file (XML). (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
When the specified feature is of type enumeration, you can use one of the following to inquire about the specified enumeration entry in the supported enumeration list of the feature. When the information pertains to a specific enumeration entry (for example, M_FEATURE_ENUM_ENTRY_ACCESS_MODE + n), the value is described in relation to its position in the enumerated list, where n is the index into the enumerated list.
Note that these values can only be used when the feature type to inquire is an enumeration.
|
For inquiring about the enumeration entry of a
feature's value
|
|||||||||||||||||||||||||||||||||||||||
|
|
Description | MIL system-specific tooltip (‡) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||||||||||||||||||
|
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
|
M_FEATURE_ENUM_ENTRY_ACCESS_MODE +
n + |
Inquires whether the specified enumeration entry is implemented, available, readable, and/or writable, where n is the index into the enumerated list. Note that an error is generated if the enumeration entry does not exist in the camera's device description file (XML). To learn if the specified enumeration entry exists in the file and is implemented on your camera, use the M_FEATURE_IS_IMPLEMENTED macro. (summarize)Inquires whether the specified enumeration entry is implemented, available, readable, and/or writable, where n is the index into the enumerated list. (more details...) |
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
|
UserVarPtr extra info |
Data type info:
Data type: address of a
MIL_INT64
Data type info:
Data type: address of a
MIL_INT64
|
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
|
Bit-encoded access mode
value |
Specifies a bit-encoded value that details the access mode. To establish the access mode from the encoded value, use the following macros: Specifies a bit-encoded value that details the access mode. (more details...) |
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
| M_FEATURE_ENUM_ENTRY_COUNT + |
Inquires the total number of enumeration entries in the supported enumerated list of the feature. Note that this inquire type can only be used when the feature to inquire is of type enumeration. (summarize)Inquires the total number of enumeration entries in the supported enumerated list of the feature. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr extra info |
Data type info:
Data type: address of a
MIL_INT
Data type info:
Data type: address of a
MIL_INT
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| Value |
Specifies the total number of enumeration entries. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_FEATURE_ENUM_ENTRY_DESCRIPTION +
n + |
Inquires the description of the specified enumeration entry, where n is the index into the enumerated list. Note that this inquire type can only be used when the feature type to inquire is an enumeration. (summarize)Inquires the description of the specified enumeration entry, where n is the index into the enumerated list. (more details...) |
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
|
UserVarPtr extra info |
|
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
|
Value |
Specifies the enumeration entry's description. |
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
|
M_FEATURE_ENUM_ENTRY_DISPLAY_NAME +
n + |
Inquires the display name of the specified enumeration entry, where n is the index into the enumerated list. Note that this can differ slightly from the internally-used name of the entry (M_FEATURE_ENUM_ENTRY_NAME + n). (summarize)Inquires the display name of the specified enumeration entry, where n is the index into the enumerated list. (more details...) |
‡ | o | v | |||||||||||||||||||||||||||||||||||
|
UserVarPtr extra info |
|
‡ | o | v | |||||||||||||||||||||||||||||||||||
|
Value |
Specifies the enumeration entry's display name. |
‡ | o | v | |||||||||||||||||||||||||||||||||||
| M_FEATURE_ENUM_ENTRY_NAME + n
+ |
Inquires the internally-used name of the specified enumeration entry of the feature, where n is the index into the enumerated list. Note that this can differ slightly from the display name of the entry (M_FEATURE_ENUM_ENTRY_DISPLAY_NAME + n). (summarize)Inquires the internally-used name of the specified enumeration entry of the feature, where n is the index into the enumerated list. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr extra info |
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| Value |
Specifies the enumeration entry's name. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_FEATURE_ENUM_ENTRY_TOOLTIP + n
+ |
Inquires the tool-tip for the specified enumeration entry, where n is the index into the enumerated list. (summarize)Inquires the tool-tip for the specified enumeration entry, where n is the index into the enumerated list. (more details...) |
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
| UserVarPtr extra info |
|
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
|
Value |
Specifies the enumeration entry's tooltip. |
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
| M_FEATURE_ENUM_ENTRY_VALUE + n
+ |
Inquires the enumeration integer value of the specified enumeration entry, where n is the index into the enumerated list. (summarize)Inquires the enumeration integer value of the specified enumeration entry, where n is the index into the enumerated list. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr extra info |
Data type info:
Data type: address of a
MIL_INT64
Data type info:
Data type: address of a
MIL_INT64
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
Value |
Specifies the enumeration entry's integer value. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_FEATURE_ENUM_ENTRY_VISIBILITY + n
+ |
Inquires the visibility level of the specified enumeration entry, where n is the index into the enumerated list. The visibility level indicates the level of expertise required to view or select the enumeration entry. When creating a custom user interface for the camera's device description file (XML), the visibility level of the specified enumeration entry can be used to potentially hide the specified enumeration entry. The current level of visibility should be set within your custom user-interface, and the visibility level of the specified enumeration entry must be compared against it. If the specified enumeration entry has a level of visibility higher than the current level of visibility, it is hidden. (summarize)Inquires the visibility level of the specified enumeration entry, where n is the index into the enumerated list. (more details...) |
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
|
UserVarPtr extra info |
Data type info:
Data type: address of a
MIL_INT64
Data type info:
Data type: address of a
MIL_INT64
|
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
|
M_FEATURE_VISIBILITY_BEGINNER |
Specifies that the enumeration entry is suggested for beginners. |
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
|
M_FEATURE_VISIBILITY_EXPERT |
Specifies that the enumeration entry is suggested for experts. |
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
|
M_FEATURE_VISIBILITY_GURU |
Specifies that the enumeration entry is suggested for advanced experts. |
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
|
M_FEATURE_VISIBILITY_INVISIBLE |
Specifies that the enumeration entry should not be shown in the user-interface for the camera's device description file (XML). Note that an invisible feature can still be set or inquired using MdigControlFeature() and MdigInquireFeature(), respectively. (summarize)Specifies that the enumeration entry should not be shown in the user-interface for the camera's device description file (XML). (more details...) |
‡ | c U25 |
o | p | v | |||||||||||||||||||||||||||||||||
When the specified feature is of type category or "Root", you can use one of the following to inquire about its subfeatures. This is useful for enumerating the features of your camera.
|
For inquiring about the subfeatures of a
feature
|
|||||||||||||||||||||||||||||||||||||||
|
|
Description | MIL system-specific tooltip (‡) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||||||||||||||||||
|
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
| M_SUBFEATURE_COUNT
+ |
Inquires the number of subfeatures or subcategories that the specified category feature (node) has. (summarize)Inquires the number of subfeatures or subcategories that the specified category feature (node) has. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr extra info |
Data type info:
Data type: address of a
MIL_INT
Data type info:
Data type: address of a
MIL_INT
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| Value |
Specifies the number of subfeatures. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_SUBFEATURE_NAME +
n + |
Inquires the name of the specified subfeature, where n is the index of subfeature. (summarize)Inquires the name of the specified subfeature, where n is the index of subfeature. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr extra info |
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| Value |
Specifies the name of the subfeature. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_SUBFEATURE_TYPE +
n + |
Inquires the type of the specified subfeature, where n is the index of subfeature. (summarize)Inquires the type of the specified subfeature, where n is the index of subfeature. (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr extra info |
Data type info:
Data type: address of a
MIL_INT64
Data type info:
Data type: address of a
MIL_INT64
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_TYPE_BOOLEAN |
Specifies that the feature's value is a boolean. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_TYPE_CATEGORY |
Specifies that the feature is a category. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_TYPE_COMMAND |
Specifies that the feature is a command to be executed. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_TYPE_DOUBLE |
Specifies that the feature's value is a floating-point. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_TYPE_ENUMERATION |
Specifies that the feature's value is an enumeration. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_TYPE_INT64 |
Specifies that the feature's value is a 64-bit integer. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
|
M_TYPE_REGISTER |
Specifies that the feature is mapped to a multi-byte register. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| M_TYPE_STRING |
Specifies that the feature's value is a string. |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
You can add one of the following values to the above-mentioned values to specify the GenTL configuration file (XML file) that is associated with the feature.
|
For specifying the configuration file associated with
the feature
|
|||||||||||||||||||||||||||||||||||||||
| Combination
value |
Description |
MIL system-specific tooltip (‡) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||||||||||||||||||
|
|
Specifies that the feature is associated with an instance of the GenTL stream configuration information. (summarize)Specifies that the feature is associated with an instance of the GenTL stream configuration information. (more details...) |
‡ | v | ||||||||||||||||||||||||||||||||||||
| Parameters | |||||||||||||||||||||||||||||||||||||||
|
Specifies the instance (index number) of the GenTL stream library associated with the feature. |
‡ | v | |||||||||||||||||||||||||||||||||||||
|
‡ | v | |||||||||||||||||||||||||||||||||||||
| M_GENTL_DEVICE |
Specifies that the feature is associated with the GenTL device configuration information. |
‡ | v | ||||||||||||||||||||||||||||||||||||
| M_GENTL_REMOTE_DEVICE |
Specifies that the feature is associated with the GenTL remote device configuration information. This is the default value. (summarize)Specifies that the feature is associated with the GenTL remote device configuration information. (more details...) |
‡ | v | ||||||||||||||||||||||||||||||||||||
You can add the following value to the above-mentioned values to get the string's length.
|
To inquire the size of a string
|
|||||||||||||||||||||||||||||||||||||||
| InquireType
combination value |
Description | MIL system-specific tooltip (‡) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||||||||||||||||||
|
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
| M_STRING_SIZE |
Retrieves the length of the string, including the terminating null character ("\0"). Note that, when used with M_FEATURE_VALUE, you can only use this combination value if the feature is of type string. (summarize)Retrieves the length of the string, including the terminating null character ("\0"). (more details...) |
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| UserVarPtr
extra info |
Data type info:
Data type: address of a
MIL_DOUBLE
Data type info:
Data type: address of a
MIL_DOUBLE
|
‡ | c M10 |
j | k M10 |
m | o | p | r U27 |
v | y U75 |
aa | |||||||||||||||||||||||||||
| Header | Include mil.h. |
| Library | Use mil.lib. |
| DLL | Requires mil.dll. |