F_VN_DrawLine

Syntax

Definition:

FUNCTION F_VN_DrawLine : HRESULT
VAR_INPUT
    nX1         : UDINT;
    nY1         : UDINT;
    nX2         : UDINT;
    nY2         : UDINT;
    ipDestImage : ITcVnImage;
END_VAR
VAR_IN_OUT
    aColor      : TcVnVector4_LREAL;
END_VAR
VAR_INPUT
    nThickness  : DINT;
    hrPrev      : HRESULT;
END_VAR

Inputs

Name	Type	Description
nX1	UDINT	x coordinate of the start point
nY1	UDINT	y coordinate of the start point
nX2	UDINT	x coordinate of the end point
nY2	UDINT	y coordinate of the end point
ipDestImage	ITcVnImage	Destination image
nThickness	DINT	Line thickness
hrPrev	HRESULT	HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.)

In/Outputs

Name	Type	Description
aColor	TcVnVector4_LREAL	Color

Return value

HRESULT

16#734

OUTOFRANGE

Part of the line lies outside of the image area. Use the function F_VN_ClipLineToBoundary_ITcVnImage to ensure that the specified line fits in the image area.

Required License

TC3 Vision Base

System Requirements

Development environment	Target platform	PLC libraries to include
TwinCAT V3.1.4024.54 or later	PC or CX (x64) with PL50, e.g. Intel 4-core Atom CPU	Tc3_Vision