imaqImageToClipboard

NI Vision for LabWindows/CVI Function

imaqImageToClipboard

Usage

int imaqImageToClipboard(const Image* image, const RGBValue* palette);

Purpose

Copies an image onto the clipboard.

Image Types Supported

IMAQ_IMAGE_U8, IMAQ_IMAGE_RGB

Parameters

Name

Type

Description

image const Image* The image to copy onto the clipboard.
palette const RGBValue* An optional palette to associate with 8-bit images. If this parameter is not NULL, it must point to an array of 256 colors, which represent the color palette that the function associates with the image. If this parameter is NULL, the function associates a grayscale palette with the image.

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