imaqGetImageSize

NI Vision for LabWindows/CVI Function

imaqGetImageSize

Usage

int imaqGetImageSize(const Image* image, int* width, int* height);

Purpose

Returns the size of a given 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 const Image* The image whose size the function queries.
width int* On return, the width of the image. Set this parameter to NULL if you do not need this information.
height int* On return, the height of the image. Set this parameter to NULL if you do not need this information.

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