MdigInquireFeature
| Board | Supported |
|---|---|
| Host System | No |
| V4L2 | Partial |
| Clarity UHD | No |
| Concord PoE | No |
| GenTL | Yes |
| GevIQ | Partial |
| GigE Vision | Partial |
| Indio | No |
| Iris GTX | No |
| Radient eV-CL | Partial |
| Rapixo CL | Partial |
| Rapixo CoF | Partial |
| Rapixo CXP | Partial |
| USB3 Vision | Partial |
Inquires a feature of the camera.
Syntax
void MdigInquireFeature(
AIL_ID DigId, //in
AIL_INT64 InquireType, //in
AIL_CONST_TEXT_PTR FeatureName, //in
AIL_INT64 UserVarType, //in
void * UserVarPtr //out
)
Description
This 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.
The features described in this function are primarily available to check existing settings using Aurora Imaging Library code or to retrieve information from which you can build your own interface for the camera device's description file (XML). Aurora Imaging Library provides two versions of an interface that you can use to interactively inquire the camera's features. At design-time, you can use Aurora Imaging Intellicam's Feature Browser. At runtime, you can launch Feature Browser, using MdigControl with M_GC_FEATURE_BROWSER. Both versions of Feature Browser provide a list of available feature names and associated possible values, as well as code snippets with the Aurora Imaging Library functions and Aurora Imaging Library constants associated with the settings selected; you can copy the code snippets to your Aurora Imaging Library 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 UserVarPtrparameter using theM_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.
System specific
| Board(s) | Note |
|---|---|
| Radient eV-CL, Rapixo 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. For more information, refer to Using Aurora Imaging Library with GenICam. |
Parameters
DigId (in, AIL_ID)
Specifies the identifier of the digitizer accessing the camera to inquire. This parameter must be given a valid digitizer identifier, previously allocated using MdigAlloc.
InquireType (in, AIL_INT64)
Specifies the type of information to inquire about the feature.
FeatureName (in, AIL_CONST_TEXT_PTR)
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 |
|---|---|
"FeatureName" | 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. |
| "Root" | 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_.... |
UserVarType (in, AIL_INT64)
Specifies the data type of the address pointed to by the UserVarPtrparameter. If not inquiring the feature's value (using M_FEATURE_VALUE), set this parameter to M_DEFAULT.
For specifying the UserVarPtr's data type
| Value | Description |
|---|---|
M_TYPE_BOOLEAN | Specifies that UserVarPtr is passed an address of type_AIL_BOOL_. |
M_TYPE_DOUBLE | Specifies that UserVarPtr is passed an address of type AIL_DOUBLE. |
M_TYPE_INT64 | Specifies that UserVarPtr is passed an address of type AIL_INT64. |
M_TYPE_STRING | Specifies that UserVarPtr is passed an address of type AIL_TEXT_CHAR. |
M_TYPE_UINT8 | Specifies that UserVarPtr is passed an address of type AIL_UINT8. |
For specifying the length of the array
| Value | Description |
|---|---|
M_FEATURE_USER_ARRAY_SIZE | Specifies the length of the array. |
UserVarPtr *(out, void)
Specifies the address of the variable in which to return the requested information.
Parameter Associations
For specifying the type of information to inquire about the feature and the data type returned
The following inquire types are used to specify the type of information about the feature to inquire and the data type 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.
| Value | Description |
|---|---|
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: - 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. |
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.
| Value | Description |
|---|---|
M_FEATURE_CACHING_MODE_NONE | Specifies that the feature is not cachable. |
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. |
M_FEATURE_CACHING_MODE_WRITE_THROUGH | Specifies that when information is written to the camera, the cache is updated simultaneously. |
M_FEATURE_CHANGE_HOOK
Inquires whether an event occurs when the value of the specified feature changes. If enabled, MdigHookFunction with M_FEATURE_CHANGE hooks a specified function to the feature change event.
| Value | Description |
|---|---|
M_DISABLE (default) | Specifies that no event is generated when the value of the specified feature changes. |
M_ENABLE | Specifies that an event is generated when the value of the specified feature changes. |
M_FEATURE_DEPRECATED
Inquires whether the specified feature is deprecated and should no longer be used.
| Value | Description |
|---|---|
M_FALSE | Specifies that the feature is not depreciated. |
M_TRUE | Specifies that the feature is depreciated. |
M_FEATURE_DESCRIPTION
Inquires the description of the specified feature.
| Value | Description |
|---|---|
Value | Specifies the description of the feature. |
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).
| Value | Description |
|---|---|
Value | Specifies the display name of the feature. |
M_FEATURE_EXECUTE_COMPLETED
Board availability: GenTL, GevIQ, GigE Vision, V4L2
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.
| Value | Description |
|---|---|
M_FALSE | Specifies that the executable camera feature has not finished executing. |
M_TRUE | Specifies that the executable camera feature has finished executing. |
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.
| Value | Description |
|---|---|
Value | Specifies the feature's incremental value. |
M_FEATURE_MAX
Inquires the maximum possible value for the feature.
| Value | Description |
|---|---|
Value | Specifies the maximum possible value for the feature. |
M_FEATURE_MIN
Inquires the minimum possible value for the feature.
| Value | Description |
|---|---|
Value | Specifies the maximum possible value for the feature. |
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).
| Value | Description |
|---|---|
Value | Specifies the feature's name. |
M_FEATURE_POLLING_INTERVAL
Board availability: GenTL, GevIQ, GigE Vision, Rapixo CXP, Rapixo CoF, V4L2
Inquires the interval between inquiring an executable feature's completion status, when automatically polling (using MsysControl with M_GC_FEATURE_EXECUTE_POLLING_MODE).
| Value | Description |
|---|---|
Value >= -1 | Specifies the polling interval, in msecs. |
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), useM_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.
| Value | Description |
|---|---|
M_NO | Specifies that the specified feature is not present. |
M_YES | Specifies that the specified feature is present. |
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 Feature Browser (accessible through Aurora Imaging Intellicam orMdigControl with M_GC_FEATURE_BROWSER). Note that this inquire type can only be used with a feature that has a data type of AIL_INT64 or AIL_DOUBLE.
| Value | Description |
|---|---|
M_FEATURE_REPRESENTATION_BOOLEAN | Specifies that the feature should be displayed as a checkbox. |
M_FEATURE_REPRESENTATION_HEX_NUMBER | Specifies that the feature should be displayed as a hexadecimal value. |
M_FEATURE_REPRESENTATION_IPV4_ADDRESS | Specifies that the feature should be displayed as an IP address in dotted decimal notation. |
M_FEATURE_REPRESENTATION_LINEAR | Specifies that the feature should be displayed as a slider with the appropriate range shown. |
M_FEATURE_REPRESENTATION_LOGARITHMIC | Specifies that the feature should be displayed as a slider with the appropriate logarithmic range shown. |
M_FEATURE_REPRESENTATION_MAC_ADDRESS | Specifies that the feature should be displayed as a hexadecimal MAC address. |
M_FEATURE_REPRESENTATION_PURE_NUMBER | Specifies that the feature should be displayed as edit text-box with a decimal display. |
M_FEATURE_SELECTOR_COUNT
Board availability: GenTL, GevIQ, GigE Vision, USB3 Vision, V4L2
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 AcquisitionStartare 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.
| Value | Description |
|---|---|
Value | Specifies the number of ancestor selectors of the feature. |
M_FEATURE_SELECTOR_NAME + n
Board availability: GenTL, GevIQ, GigE Vision, USB3 Vision, V4L2
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.
| Value | Description |
|---|---|
Value | Specifies the name associated with the selector index. |
M_FEATURE_SIZE
Inquires the size of the feature's value.
| Value | Description |
|---|---|
Value | Specifies the feature's size, in bytes. |
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.
| Value | Description |
|---|---|
M_FALSE | Specifies that the feature is not streamable. |
M_TRUE | Specifies that the feature is streamable. |
M_FEATURE_TOOLTIP
Inquires the tooltip of the specified feature.
| Value | Description |
|---|---|
Value | Specifies the feature's tooltip. |
M_FEATURE_TYPE
Inquires the specified feature's type.
| Value | Description |
|---|---|
M_TYPE_BOOLEAN | Specifies that the feature's value is a boolean. |
M_TYPE_CATEGORY | Specifies that the feature is a category feature, and its value cannot be inquired. |
M_TYPE_COMMAND | Specifies that the feature is a command and its value cannot be inquired. |
M_TYPE_DOUBLE | Specifies that the feature's value is a floating-point. |
M_TYPE_ENUMERATION | Specifies that the feature's value is an enumeration. |
M_TYPE_INT64 | Specifies that the feature's value is a 64-bit integer. |
M_TYPE_REGISTER | Specifies that the feature's value is mapped to a multi-byte register. |
M_TYPE_STRING | Specifies that the feature's value is a string. |
M_FEATURE_VALID_VALUE_COUNT
Board availability: GenTL, GevIQ, GigE Vision, USB3 Vision, V4L2
Inquires the number of valid values for the specified feature. Integer and floating-point type features can support a fixed list of valid values instead of the traditional minimum, maximum and increment values.
| Value | Description |
|---|---|
Value | Specifies the number of valid values. > Note: A value of 0 returned indicates the feature does not support a list of valid values. Minimum, maximum and increment values must be used instead. |
M_FEATURE_VALID_VALUE + n
Board availability: GenTL, GevIQ, GigE Vision, USB3 Vision, V4L2
Inquires the nth valid value of the feature, where n is a value between 0 and M_FEATURE_VALID_VALUE_COUNT.
| Value | Description |
|---|---|
Value | Specifies the valid value. |
M_FEATURE_VALUE
Inquires the current value of the feature.
| Value | Description |
|---|---|
Value | Specifies the feature's value. |
M_FEATURE_VALUE_ARRAY
Board availability: GenTL, GevIQ, GigE Vision, Radient eV-CL, Rapixo CL, Rapixo CXP, Rapixo CoF, USB3 Vision, V4L2
Inquires the array of values of the specified feature. The array of values will be inquired without needing to be indexed by a selector. This is internally handled by Aurora Imaging Library and simplifies implementation.
M_FEATURE_VALUE_ARRAY_SIZE
Board availability: GenTL, GevIQ, GigE Vision, Radient eV-CL, Rapixo CL, Rapixo CXP, Rapixo CoF, USB3 Vision, V4L2
Inquires the number of elements in the specified feature's array of values. For use with M_FEATURE_VALUE_ARRAY.
| Value | Description |
|---|---|
Value >= 0 | Specifies the number of elements in the feature array. |
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.
| Value | Description |
|---|---|
M_FEATURE_VISIBILITY_BEGINNER | Specifies that the feature is suggested for beginners. |
M_FEATURE_VISIBILITY_EXPERT | Specifies that the feature is suggested for experts. |
M_FEATURE_VISIBILITY_GURU | Specifies that the feature is suggested for advanced experts. |
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. |
For inquiring about the enumeration entry of a feature's value
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: Note that these values can only be used when the feature type to inquire is an enumeration.
M_FEATURE_ENUM_ENTRY_ACCESS_MODE + n
Board availability: GenTL, GevIQ, GigE Vision, USB3 Vision, V4L2
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.
| Value | Description |
|---|---|
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: - 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. |
M_FEATURE_ENUM_ENTRY_CACHING_MODE + n
Board availability: GenTL, GevIQ, GigE Vision, USB3 Vision, V4L2
Inquires the caching mode of the specified enumeration entry, where n is the index into the enumerated list. The caching mode indicates whether a copy of the specified enumeration entry's value is stored in Host memory for the enumeration entry. If so, the enumeration entry is known as cachable. A cachable enumeration entry 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 enumeration entry 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.
| Value | Description |
|---|---|
M_FEATURE_CACHING_MODE_NONE | Specifies that the enumeration entry is not cachable. |
M_FEATURE_CACHING_MODE_WRITE_AROUND | Specifies that enumeration entry's values are written only to the camera, and the cache is updated the next time the enumeration entry's value is inquired. |
M_FEATURE_CACHING_MODE_WRITE_THROUGH | Specifies that when the enumeration entry's values are written to the camera, the cache is updated simultaneously. |
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.
| Value | Description |
|---|---|
Value | Specifies the total number of enumeration entries. |
M_FEATURE_ENUM_ENTRY_DESCRIPTION + n
Board availability: GenTL, GevIQ, GigE Vision, USB3 Vision, V4L2
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.
| Value | Description |
|---|---|
Value | Specifies the enumeration entry's description. |
M_FEATURE_ENUM_ENTRY_DISPLAY_NAME + n
Board availability: GenTL, USB3 Vision, V4L2
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).
| Value | Description |
|---|---|
Value | Specifies the enumeration entry's display name. |
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).
| Value | Description |
|---|---|
Value | Specifies the enumeration entry's name. |
M_FEATURE_ENUM_ENTRY_STREAMABLE + n
Board availability: GenTL, GevIQ, GigE Vision, USB3 Vision, V4L2
Inquires whether the specified enumeration entry, where n is the index into the enumerated list is streamable. A streamable enumeration entry can be stored in the local camera's description file (an XML file stored on your computer). Streamable enumeration entries are typically not persistent values. In most cases, a streamable enumeration entry is capable of being saved and loaded from file at a later date, possibly on a different camera.
| Value | Description |
|---|---|
M_FALSE | Specifies that enumeration entry is not streamable. |
M_TRUE | Specifies that when the enumeration entry is streamable. |
M_FEATURE_ENUM_ENTRY_TOOLTIP + n
Board availability: GenTL, GevIQ, GigE Vision, USB3 Vision, V4L2
Inquires the tool-tip for the specified enumeration entry, where n is the index into the enumerated list.
| Value | Description |
|---|---|
Value | Specifies the enumeration entry's tooltip. |
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.
| Value | Description |
|---|---|
Value | Specifies the enumeration entry's integer value. |
M_FEATURE_ENUM_ENTRY_VISIBILITY + n
Board availability: GenTL, GevIQ, GigE Vision, USB3 Vision, V4L2
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.
| Value | Description |
|---|---|
M_FEATURE_VISIBILITY_BEGINNER | Specifies that the enumeration entry is suggested for beginners. |
M_FEATURE_VISIBILITY_EXPERT | Specifies that the enumeration entry is suggested for experts. |
M_FEATURE_VISIBILITY_GURU | Specifies that the enumeration entry is suggested for advanced experts. |
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 enumeration entry can still be set or inquired using MdigControlFeature and MdigInquireFeature, respectively. |
For inquiring about the subfeatures of a feature
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.
M_SUBFEATURE_COUNT
Inquires the number of subfeatures or subcategories that the specified category feature (node) has.
| Value | Description |
|---|---|
Value | Specifies the number of subfeatures. |
M_SUBFEATURE_NAME + n
Inquires the name of the specified subfeature, where n is the index of subfeature.
| Value | Description |
|---|---|
Value | Specifies the name of the subfeature. |
M_SUBFEATURE_TYPE + n
Inquires the type of the specified subfeature, where n is the index of subfeature.
| Value | Description |
|---|---|
M_TYPE_BOOLEAN | Specifies that the feature's value is a boolean. |
M_TYPE_CATEGORY | Specifies that the feature is a category. |
M_TYPE_COMMAND | Specifies that the feature is a command to be executed. |
M_TYPE_DOUBLE | Specifies that the feature's value is a floating-point. |
M_TYPE_ENUMERATION | Specifies that the feature's value is an enumeration. |
M_TYPE_INT64 | Specifies that the feature's value is a 64-bit integer. |
M_TYPE_REGISTER | Specifies that the feature is mapped to a multi-byte register. |
M_TYPE_STRING | Specifies that the feature's value is a string. |
Combination Constants — For specifying the configuration file associated with the feature
Optional.
Usage: 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.
Board availability: GenTL
| Value | Description |
|---|---|
M_GENTL_STREAM_NUMBER | Specifies that the feature is associated with an instance of the GenTL stream configuration information. |
M_GENTL_DEVICE | Specifies that the feature is associated with the GenTL device configuration information. |
M_GENTL_REMOTE_DEVICE (default) | Specifies that the feature is associated with the GenTL remote device configuration information. |
Combination Constants — To inquire the size of a string
Optional, cannot be used alone.
Usage: You can add one of the following values to the above-mentioned values to get the string's length.
M_STRING_SIZE
Retrieves the length of the string, including the terminating null character ("\0"). Note that, when used withM_FEATURE_VALUE, you can only use this combination value if the feature is of type string.