imaqSetBorderSize

NI Vision for LabWindows/CVI Function

imaqSetBorderSize

Usage

int imaqSetBorderSize(Image* image, int size);

Purpose

Sets the border size of an image. This operation preserves image pixels.

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 whose border size the function sets.
size int The new border size. Valid border sizes range from 0-50.

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