imaqCreateOverlayFromMetafile

NI Vision for LabWindows/CVI Function

imaqCreateOverlayFromMetafile

Usage

Overlay* imaqCreateOverlayFromMetafile(const void* metafile);

Purpose

Creates a window overlay from a Windows metafile or enhanced metafile. This function is obsolete. You should use imaqOverlayMetafile() instead. The new function overlays the metafile directly on to the image instead of returning an overlay.

Note  This function is obsolete. The replacement function is imaqOverlayMetafile(), which overlays the metafile directly on to the image instead of returning an overlay.

Parameters

Name

Type

Description

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.

Return Value

Type

Description

Overlay* On success, this function returns an overlay. On failure, this function returns NULL. To get extended error information, call imaqGetLastError(). When you are finished with the overlay, dispose of it by calling imaqDispose().