IMAQdxGetAttributeCW

NI-IMAQdx Function Reference

IMAQdxGetAttributeCW

Format

IMAQdxGetAttributeCW (id As IMAQdxSession, name As String, type As IMAQdxValueType, value As VARIANT) As IMAQdxError

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 String 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 VARIANT (passed by reference) The value of the specified attributes when the function returns.

Parameter Discussion

type specifies the type of the value parameter. The following types are supported: IMAQdxValueTypeU32, IMAQdxValueTypeI64, IMAQdxValueTypeF64, IMAQdxValueTypeString, IMAQdxValueTypeEnumItem, and IMAQdxValueTypeBool.

Note 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 IMAQdxGetErrorStringCW.