IMAQ Copy Acquired Buffer VI

NI-IMAQ VI

IMAQ Copy Acquired Buffer VI

Installed With: NI Vision Acquisition Software

Returns a copy of an acquired image. IMAQ Copy Acquired Buffer allows you to copy an image from onboard memory to system memory, or from driver-allocated system memory to user-allocated system memory.

IMAQ Copy Acquired Buffer

crn.gif

IMAQ Session In identifies the device.

cgenclasstagrefflat.gif

Image In is a reference to an image.

cu32.gif

Buffer Number is the index of the buffer in the buffer list you want to acquire.

cenum.gif

Overwrite Mode is applicable only when you are copying acquired buffers that have been overwritten.

Get Oldest (0)

Gets the oldest available buffer.

Get Next Iteration (1)

Gets the next available buffer, which is determined by the buffer index. The buffer index is the remainder of the buffer number divided by the number of buffers in the buffer list.

Fail (2)

Causes the copy to return an error when it encounters an overwritten buffer.

cerrcodeclst.gif

error in (no error) describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.

cbool.gif

status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.

ci32.gif

code code is the number identifying an error or warning. If status is TRUE, code is a non-zero error code. If status is FALSE, code can be zero or a warning code. Use the error handler VIs to look up the meaning of this code and to display the corresponding error message.

cstr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

c1di32.gif

Region of Interest specifies a rectangular portion of the image. Region of Interest is defined by an array of four elements [Left, Top, Right, Bottom]. You must set the width [Right-Left] to a multiple of eight. The [Right] and [Bottom] coordinates are exclusive. If Region of Interest is not connected or empty, the entire acquisition window is captured.

irn.gif

IMAQ Session Out has the same value as IMAQ Session In.

igenclasstagrefflat.gif

Image Out is a reference to the image.

ii32.gif

Buffer Number Copied is the number of the copied buffer.

ii32.gif

Buffer Index Copied is the buffer index of the copied buffer.

ierrcodeclst.gif

error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out indicator on the front panel and select Explain Error from the shortcut menu for more information about the error.

ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

ii32.gif

code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.

istr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.