IMcImageSetReleaseImage Method

Sub ReleaseImage ( 
	Image As McImage
)

This is a very advanced method, intended for advanced set acquisition and management. Some explanation may be necessary to understand the effects of this method. Typically an image is added to a set using AddImage or AddFrames. At this point the set is "loaded", meaning that the frames used by the set are resident in memory and can easily be displayed during navigation. However, frames can be members of a set while not actually resident in memory, represented by an image file or a portion of a multi-frame image file. This method sets all frames of the specified image as being non-resident, i.e. "not loaded", or backed up only by the image file(s) containing the frame(s). Typically this is used during advanced set acquisition, where a single-frame image is used for capturing all of the frames of a set, saving each frame to an image file prior to acquiring the next frame. This method would be used during such an acquisition, as in this incredibly over-simplified example loop of pseudo-code: While Not Done Capture to current (working) image Save current image to file Add to set ReleaseImage( currentImage ) End While Note that an image that is a member of any set cannot be fully released (and its memory freed for use by other images) until the image is either released from all sets using this method, or removed from all sets. This is because the set itself holds one or more references to all the images that contribute to the set that are loaded.