get_partT_get_partGetPartGetPart (Operator)

Name

get_partT_get_partGetPartGetPart — Get the image part.

Signature

get_part( : : WindowHandle : Row1, Column1, Row2, Column2)

Herror T_get_part(const Htuple WindowHandle, Htuple* Row1, Htuple* Column1, Htuple* Row2, Htuple* Column2)

void GetPart(const HTuple& WindowHandle, HTuple* Row1, HTuple* Column1, HTuple* Row2, HTuple* Column2)

void HWindow::GetPart(HTuple* Row1, HTuple* Column1, HTuple* Row2, HTuple* Column2) const

void HWindow::GetPart(Hlong* Row1, Hlong* Column1, Hlong* Row2, Hlong* Column2) const

static void HOperatorSet.GetPart(HTuple windowHandle, out HTuple row1, out HTuple column1, out HTuple row2, out HTuple column2)

void HWindow.GetPart(out HTuple row1, out HTuple column1, out HTuple row2, out HTuple column2)

void HWindow.GetPart(out int row1, out int column1, out int row2, out int column2)

Description

get_partget_partGetPartGetPartGetPart returns the upper left and lower right corner of the image part shown in the window. The image part can be changed with the operator set_partset_partSetPartSetPartSetPart (Default is the whole image).

Execution Information

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window HWindow, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

Row1Row1Row1Row1row1 (output_control)  rectangle.origin.y HTupleHTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)

Row index of the image part's upper left corner.

Column1Column1Column1Column1column1 (output_control)  rectangle.origin.x HTupleHTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)

Column index of the image part's upper left corner.

Row2Row2Row2Row2row2 (output_control)  rectangle.corner.y HTupleHTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)

Row index of the image part's lower right corner.

Column2Column2Column2Column2column2 (output_control)  rectangle.corner.x HTupleHTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)

Column index of the image part's lower right corner.

Result

get_partget_partGetPartGetPartGetPart returns 2 (H_MSG_TRUE) if the window is valid. Otherwise an exception is raised.

Possible Successors

set_partset_partSetPartSetPartSetPart, disp_regiondisp_regionDispRegionDispRegionDispRegion, disp_imagedisp_imageDispImageDispImageDispImage

See also

set_partset_partSetPartSetPartSetPart, disp_imagedisp_imageDispImageDispImageDispImage, disp_regiondisp_regionDispRegionDispRegionDispRegion, disp_colordisp_colorDispColorDispColorDispColor

Module

Foundation