LFile::StopFeedLoad

#include "ltwrappr.h"

virtual L_INT LFile::StopFeedLoad()

Ends a file-load process in which you control the input stream. This cleans up all the variables and buffers allocated by the LFile::StartFeedLoad and LFile::FeedLoad functions and resets all internal variables to their default settings.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

You must call this function to complete a file load that was started with LFile::StartFeedLoad. If you call this function before supplying the complete file, it will successfully clean up the process, but will return a file-read error. You should trap the error if the load is canceled purposely.

For a description of how the functions relate to each other, refer to LFile::StartFeedLoad.

This function cannot be used in combination with the Redirect input / output functions.

Required DLLs and Libraries

LTFIL
File format DLLs

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

See Also

Functions:

Class Members

Topics:

Raster Image Functions: Loading Files

 

Raster Image Functions: Redirecting Input and Output

 

Raster Image Functions: Input and Output

 

Loading and Saving Images

Example

For an example, refer to LFile::StartFeedLoad.