imaqLoadPattern

NI Vision for LabWindows/CVI Function

imaqLoadPattern

Usage

int imaqLoadPattern(Image* pattern, const char* fileName);

Purpose

Loads a template image previously saved with the imaqSavePattern() function.

Note  This function is obsolete. The replacement function is imaqReadVisionFile(), which can load files that contain additional vision information such as an overlay. Files saved with imaqWriteVisionFile() cannot be loaded using imaqLoadPattern().

Image Types Supported

IMAQ_IMAGE_U8

Parameters

Name

Type

Description

pattern Image* The template image.
fileName const char* The name of the image file to load.

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().