imgSessionGetROI

Usage

rval imgSessionGetROI(SESSION_ID sid, uInt32* top, uInt32* left, uInt32* height, uInt32* width);

Purpose

Gets the acquisition region of interest (ROI).

Parameters

Name	Type	Direction
sid	SESSION_ID	input
top	uInt32*	output
left	uInt32*	output
height	uInt32*	output
width	uInt32*	output
rval	Int32	output

Parameter Discussion

sid: valid SESSION_ID.

top: on return, the function sets top to the current value of IMG_ATTR_ROI_TOP.

left: on return, the function sets left to the current value of IMG_ATTR_ROI_LEFT.

height: on return, the function sets height to the current value of IMG_ATTR_ROI_HEIGHT.

width: on return, the function sets width to the current value of IMG_ATTR_ROI_WIDTH.

Return Value

This function returns 0 on success. On failure, this function returns an error code. For information about the error code, call imgShowError.