F_VN_ExportImageAsBmpExp

Exports the image as bitmap into a given buffer (e.g. an array). F_VN_ExportImageAsBmpSizeExp should be called before to get the required buffer size. (expert function)
Can use available TwinCAT Job Tasks for executing parallel code regions.

Syntax

Definition:

FUNCTION F_VN_ExportImageAsBmpExp : HRESULT
VAR_INPUT
    ipImage     : ITcVnImage;
    pBuffer     : PVOID;
    nBufferSize : ULINT;
    nWidth      : UDINT;
    nHeight     : UDINT;
    hrPrev      : HRESULT;
END_VAR

Inputs

Name	Type	Description
ipImage	ITcVnImage	Image
pBuffer	PVOID	Pointer to a buffer to store the bitmap image (Make sure to allocate enough memory! The required size in bytes can be determined using the function F_VN_ExportImageAsBmpSizeExp)
nBufferSize	ULINT	Size of the buffer memory in bytes
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.)

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