imaqWriteAVIFrame

NI Vision for LabWindows/CVI Function

imaqWriteAVIFrame

Usage

int imaqWriteAVIFrame(Image* image, AVISession session, const void* data, unsigned int dataLength);

Purpose

This function writes an image to an AVI file, as well as data to attach to this image (if the AVI file was created to allow this).

Image Types Supported

IMAQ_IMAGE_U8, IMAQ_IMAGE_RGB

Parameters

Name

Type

Description

image Image* The image to write to the AVI.
session AVISession The session to use.
data const void* If this AVI has data attached to it, the data to attach to this frame.
dataLength unsigned int If data is non-NULL, the length of the data to attach to this frame. This length must not exceed the maxDataLength parameter of imaqCreateAVI.

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