StopFeedLoad Method

Summary

Ends a file-load process in which you control the input stream.

Syntax

Objective-C

C++

Java

public RasterImage StopFeedLoad()

Public Function StopFeedLoad() As RasterImage

- (nullable LTRasterImage *)stopFeedLoad:(NSError **)error

public RasterImage stopFeedLoad()

public: 
RasterImage^ StopFeedLoad();

Return Value

The image loaded by the FeedLoad process.

Remarks

This cleans up all the variables and buffers allocated by the StartFeedLoad and FeedLoad methods and resets all internal variables to their default settings.

You must call this method to complete a file load that was started with StartFeedLoad.

If you call this method before supplying the complete file, it will successfully clean up the process, but will throw a file-read exception. You should trap the error if the load is canceled purposely.

For a description of how the methods relate to each other, refer to StartFeedLoad.

Example

For an example, refer to StartFeedLoad.

Requirements

Target Platforms