LEADTOOLS Image File Support (Leadtools.Codecs assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
StopFeedLoad Method
See Also 
Leadtools.Codecs Namespace > RasterCodecs Class : StopFeedLoad Method



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

Syntax

Visual Basic (Declaration) 
Public Function StopFeedLoad() As RasterImage
Visual Basic (Usage)Copy Code
Dim instance As RasterCodecs
Dim value As RasterImage
 
value = instance.StopFeedLoad()
C# 
public RasterImage StopFeedLoad()
C++/CLI 
public:
RasterImage^ StopFeedLoad(); 

Return Value

The image loaded by the FeedLoad(Byte[],Int32,Int32) process.

Example

For an example, refer to StartFeedLoad(Int32,CodecsLoadByteOrder).

Remarks

This cleans up all the variables and buffers allocated by the StartFeedLoad(Int32,CodecsLoadByteOrder) and FeedLoad(Byte[],Int32,Int32) 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(Int32,CodecsLoadByteOrder).

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(Int32,CodecsLoadByteOrder).

Requirements

Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also