IMAQdxGetAttribute
Format
rval = IMAQdxGetAttribute(IMAQdxSession id, char *name, IMAQdxValueType type, void *value);
Purpose
Gets the current value for a camera attribute.
Parameters
Parameter | Type | Description |
id | IMAQdxSession | A valid Session ID, which you can obtain using IMAQdxOpenCamera. |
name | char * | The name of the attribute whose value you want to get. Refer to Attribute Name for a list of attributes. |
type | IMAQdxValueType | The type of the value you want to get. |
value | void * (passed by reference) | The value of the specified attribute when the function returns. |
Parameter Discussion
name specifies the attribute whose value you want to obtain. In LabWindows/CVI function panel, when you click the control or press <Enter>, <Spacebar>, or <Ctrl-down arrow>, a dialog box opens containing a hierarchical list of the available attributes. Attributes whose values cannot be obtained are dimmed. You can access function help text for each attribute by double-clicking an attribute or by selecting the attribute and pressing <Enter>.
type specifies the type of the value parameter. The following types are supported: IMAQdxValueTypeU32, IMAQdxValueTypeI64, IMAQdxValueTypeF64, IMAQdxValueTypeString, IMAQdxValueTypeEnumItem, and IMAQdxValueTypeBool.
![]() |
Note The value type must be compatible with the attribute type. Refer to the NI-IMAQdx Help for more information about camera attributes. |
Return Value
On success, this function returns IMAQdxErrorSuccess. On failure, this function returns an error code. You can obtain a more detailed error message with IMAQdxGetErrorString.