imaqOverlayMetafile
Usage
int imaqOverlayMetafile(Image* image, const void* metafile, Rect rect, const char* group);
Purpose
Overlays a metafile onto an image.
Image Types Supported
IMAQ_IMAGE_U8, IMAQ_IMAGE_U16, IMAQ_IMAGE_I16, IMAQ_IMAGE_SGL, IMAQ_IMAGE_COMPLEX, IMAQ_IMAGE_RGB, IMAQ_IMAGE_HSL, IMAQ_IMAGE_RGB_U64
Parameters
|
Name
|
Type
|
Description
|
|---|---|---|
| image | Image* | The image on which to overlay the metafile. |
| metafile | const void* | The Windows handle to the metafile that you want to convert into an overlay. The handle may be either an HMETAFILE or HENHMETAFILE. This parameter is required and cannot be NULL. |
| rect | Rect | The location of rectangular region within the image that the function overlays the metafile. To use the bounding rectangle information stored in the metafile, set this parameter to IMAQ_NO_RECT. |
| group | const char* | The group to which you want to add the overlay. Set this parameter to NULL to add the overlay to the default group. |
Return Value
| Type |
Description |
|---|---|
| int | On success, this function returns a non-zero value. On failure, this function returns 0. To get extended error information, call imaqGetLastError(). |