imaqClipboardToImage

NI Vision for LabWindows/CVI Function

imaqClipboardToImage

Usage

int imaqClipboardToImage(Image* dest, RGBValue* palette);

Purpose

Copies an image from the clipboard.

Image Types Supported

IMAQ_IMAGE_U8, IMAQ_IMAGE_RGB

Parameters

Name

Type

Description

dest Image* The image into which the function copies the clipboard image.
palette RGBValue* An array of 256 entries that receives the palette associated with the 8-bit clipboard image. If there is no palette associated with the image, the function fills in a gray palette. Set this parameter to NULL if you do not need the palette.

Return Value

Type

Description

int On success, this function returns 1 if there was an image on the clipboard or –1 if there was no image on the clipboard. On failure, this function returns 0. To get extended error information, call imaqGetLastError().