ReleaseData Method

Summary

Releases memory locked with AccessData back to the system.

Syntax

Objective-C

- (BOOL)releaseData:(NSError **)error

Remarks

If the image data of this RasterImage object is stored in a global Windows handle, then use the ReleaseData method along with AccessData to control the access to image data in memory. Any attempt to access the image data after calling ReleaseData will result in an application error.

To make the most of available system resources, you should only keep a RasterImage object locked when you need to access the image data. Call ReleaseData to unlock the image data for more efficient use of system memory resources.

You should call this method whenever the image is not used, so that Windows can manage its memory properly.

If the image data of this RasterImage is not stored in a global Windows handle, then this method will do nothing and calling it will not have any effect on the RasterImage.

Use IsGlobalMemory to determine if the image data of this RasterImage is stored in a global Windows handle or not.

Example

For an example, refer to GetRow

Requirements

Target Platforms