AccessData Method

Summary

Provides exclusive access to the image data contained in this RasterImage.

Syntax

Objective-C

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

Remarks

If the image data of this RasterImage object is stored in a global Windows handle, then use the AccessData method to lock the memory. If you do not call this method before accessing the data with a low-level method like GetRow or SetRowthe application might fail.

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 Release to unlock the image data for more efficient use of system memory resources.

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 whether the image data of this RasterImage is stored in a global Windows handle.

Example

For an example, refer to GetRow

Requirements

Target Platforms