GetBitmapImage

GetBitmapImage 1:

Export the image as a Windows Bitmap (BMP) into a given buffer.

Syntax

Definition:

METHOD GetBitmapImage : HRESULT
VAR_INPUT
    nBitmapSize   : Reference To ULINT;
    pDestBuffer   : PVOID;
    nBitmapWidth  : Reference To UDINT;
    nBitmapHeight : Reference To UDINT;
END_VAR

GetBitmapImage 2: Inputs

Name

Type

Description

nBitmapSize

Reference To ULINT

Maximum buffer size (in) and actual buffer size (out).

pDestBuffer

PVOID

Pointer to the destination buffer.

nBitmapWidth

Reference To UDINT

Desired width or 0 to keep the original width (in) and actual width (out).

nBitmapHeight

Reference To UDINT

Desired height or 0 to keep the original height (in) and actual height (out).

GetBitmapImage 3: Return value

HRESULT