L_StopFeedLoad

Show in webframe

#include "l_bitmap.h"

L_LTFIL_API L_INT L_StopFeedLoad(hLoad)

/* handle that identifies the loading process */

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

Parameter	Description
hLoad	Handle that identifies the loading process. It is the same handle that you specify in the L_StartFeedLoad function.

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 L_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 L_StartFeedLoad.

This function cannot be used in combination with L_RedirectIO.

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, Linux.

See Also

Functions:	L_StartFeedLoad, L_FeedLoad, L_ChangeBitmapHeight
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 a short example, refer to L_StartFeedLoad. For complete sample code, refer to the FEEDLOAD example