SetRoi

Sets a region of interest (ROI) within an image.

Syntax

Definition:

HRESULT SetRoi(
    HRESULT     hrPrev,
    ULONG       nX,
    ULONG       nY,
    ULONG       nWidth,
    ULONG       nHeight,
    ITcVnImage* ipDestImage
)

Parameters

Name

Type

Description

hrPrev

HRESULT

HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.)

nX

ULONG

Left boundary (inclusive 0-based index)

nY

ULONG

Upper boundary (inclusive 0-based index)

nWidth

ULONG

ROI width

nHeight

ULONG

ROI height

ipDestImage

ITcVnImage*

Destination image

SetRoi 1: Return value

HRESULT

Required License

TC3 Vision Base

System Requirements

Development environment

Target platform

PLC libraries to include

TwinCAT V3.1. 4024.44 or later

PC or CX (x64) with PL50, e.g. Intel 4-core Atom CPU

Tc3_Vision