MbufInquireFeature

Board	Supported
Host System	No
V4L2	Yes
Clarity UHD	No
Concord PoE	No
GenTL	Yes
GevIQ	No
GigE Vision	No
Indio	No
Iris GTX	No
Radient eV-CL	No
Rapixo CL	No
Rapixo CoF	No
Rapixo CXP	No
USB3 Vision	No

Inquires a feature of the buffer.

Syntax

void MbufInquireFeature(
    AIL_ID             BufId,        //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 GenTL standard feature naming convention (SFNC) features and buffer-specific features. When used with a GenICam GenTL SFNC-compliant camera, it allows you to directly inquire various buffer-specific features specified with the GenTL buffer 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 GenICam GenTL Standard Feature Naming Convention or your GenTL-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 GenTL buffer'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 MbufControl 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 buffer-specific feature, use MbufControlFeature.

Parameters

`BufId` (in, AIL_ID)

Specifies the identifier of the buffer to inquire. This parameter must be given a valid buffer identifier, previously allocated using MbufAlloc....

`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 buffer 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 GenTL library'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.