L_GetOverlayCallback

#include "l_bitmap.h"

L_LTFIL_API L_INT L_GetOverlayCallback(ppfnCallback, ppUserData, puFlags)

OVERLAYCALLBACK ppfnCallback;

pointer to be updated with the callback function

L_VOID* ppUserData;

void pointer to be updated with user data

L_UINT* puFlags;

pointer to a variable

Gets the current overlay callback function, user data and flags, which were set using L_SetOverlayCallback.

Parameter

Description

ppfnCallback

Pointer to a pointer to a callback function to be updated with the last overlay callback function set using L_SetOverlayCallback.

ppUserData

Void pointer to be updated with the value of user defined data associated with the overlay callback. If you are not interested in the user-defined data, pass NULL for this parameter.

puFlags

Pointer to a variable to be updated with the flags used to determine the methods to perform when loading an overlay file and the order in which to perform the methods. These were also previously set using L_SetOverlayCallback.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

The overlay callback set using L_SetOverlayCallback becomes the current overlay callback. To get the current overlay callback, call L_GetOverlayCallback.

Required DLLs and Libraries

LTFIL

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_SetOverlayCallback, OVERLAYCALLBACK, L_LoadBitmap

Topics:

Raster Image Functions: Loading Files

 

Loading and Saving Images

Example

For an example, refer to the OVERLAYCALLBACK function.

Help Version 20.0.2018.2.25
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Raster Imaging C API Help