IMAQ Dispose VI

LabView NI Vision

IMAQ Dispose VI

Owning Palette: Image ManagementInstalled With: NI Vision Development Module

Destroys an image and frees the space it occupied in memory. This VI is required for each image created in an application to free the memory allocated to the IMAQ Create VI. Execute IMAQ Dispose only when the image is no longer needed in your application. You can use IMAQ Dispose for each call to IMAQ Create or just once for all images created with IMAQ Create.

Note  When a LabVIEW application is aborted, allocated images remain in memory.

IMAQ Dispose

cbool.gif

All Images? (No) specifies whether to destroy a single image or all previously created images. Giving a TRUE value on input destroys all images previously created. The default is FALSE. Be sure to use this function at the end of an application to free the memory occupied by the images.

cgenclasstagrefflat.gif

Image specifies the reference to the image to destroy.

cerrcodeclst.gif

error in (no error) describes the error status 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 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.

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.

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.