ExportImageAsBmp
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.
Can use available TwinCAT Job Tasks for executing parallel code regions.
Syntax
Definition:
HRESULT ExportImageAsBmp(
HRESULT hrPrev,
ITcVnImage* ipImage,
PVOID pBuffer,
ULONGLONG nBufferSize,
ULONG nWidth = 0,
ULONG nHeight = 0
)
Parameters
|
Name |
Type |
Default |
Description |
|---|---|---|---|
|
hrPrev |
|
HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.) | |
|
ipImage |
|
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 |
ULONGLONG |
|
Size of the buffer memory in bytes |
|
nWidth |
ULONG |
0 |
Desired width (or 0 to keep the original width) |
|
nHeight |
ULONG |
0 |
Desired height (or 0 to keep the original height) |
Return valueRequired 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 |