F_VN_ExportImageAsBmp

F_VN_ExportImageAsBmp 1:

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

Syntax

Definition:

FUNCTION F_VN_ExportImageAsBmp : HRESULT
VAR_INPUT
    ipImage     : ITcVnImage;
    pBuffer     : PVOID;
    nBufferSize : ULINT;
    hrPrev      : HRESULT;
END_VAR

F_VN_ExportImageAsBmp 2: 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_ExportImageAsBmpSize)

nBufferSize

ULINT

Size of the buffer memory in bytes

hrPrev

HRESULT

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

F_VN_ExportImageAsBmp 3: Return value

HRESULT

Further information

Note the conversion properties of the interface ITcVnBitmapExport.

Required License

TC3 Vision Base

System Requirements