AcqHandle

An acquisition handle obtained via 'open_framegrabber'.

Parameter

This can either be an interface parameter or an item path for direct tree item access.

Variable

A variable where the value to be read is stored.

Parameter

Values

Default

Type

Description

'auto_grab_data'

'true', 'false'

'true'

string

Get the 'auto_grab_data' flag for the given handle.

'error_code'

<error_code>

integer

Retrieve the API error code.

'error_item'

'<error_item_path>'

string

Retrieve the path of the tree item which caused the error.

'error_text'

'<error_text>'

string

Retrieve the error text.

'generate_regions'

'true', 'false'

'true'

string

Get the 'generate_regions' flag for the given handle.

'grab_data_items'

['<binary_node_path>']

string, tuple

List of binary nodes which will be provided when using 'grab_data' on the given handle.

'replace_nans'

'true', 'false'

'true'

string

Get the 'replace_nans' flag for the given handle.

'path'

'<node_path>'

string

Get the nxLib node path of the current handle.

AcqHandle

An acquisition handle obtained via 'open_framegrabber'.

ItemPath

A path to a tree item to be read. The item path is relative to the path with which the handle is associated.
 
Note: This operator can't be used to read binary nodes. For this purpose use 'grab_data' instead.

Variable

A variable where the value to be read is stored.