F_VN_ExportImageAsBmpSizeExp

F_VN_ExportImageAsBmpSizeExp 1:

Get the required buffer size (in bytes) to store the image as bitmap. (expert function)

Syntax

Definition:

FUNCTION F_VN_ExportImageAsBmpSizeExp : HRESULT
VAR_INPUT
    ipImage     : ITcVnImage;
END_VAR
VAR_IN_OUT
    nBufferSize : ULINT;
END_VAR
VAR_INPUT
    nWidth      : UDINT;
    nHeight     : UDINT;
    hrPrev      : HRESULT;
END_VAR

F_VN_ExportImageAsBmpSizeExp 2: Inputs

Name

Type

Description

ipImage

ITcVnImage

Image

nWidth

UDINT

Desired width (or 0 to keep the original width)

nHeight

UDINT

Desired height (or 0 to keep the original height)

hrPrev

HRESULT

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

F_VN_ExportImageAsBmpSizeExp 3: In/Outputs

Name

Type

Description

nBufferSize

ULINT

Returns the required buffer size in bytes

F_VN_ExportImageAsBmpSizeExp 4: 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