L_GetOverlayCallback

Summary

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

Syntax

#include "l_bitmap.h"

L_LTFIL_API L_INT L_GetOverlayCallback(ppfnCallback, ppUserData, puFlags)

Parameters

OVERLAYCALLBACK *ppfnCallback

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

L_VOID ** 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.

L_UINT* 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

Value Meaning
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

Platforms

Win32, x64, Linux.

See Also

Functions

Topics

Example

For an example, refer to the OVERLAYCALLBACK function.

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help
Introduction
Version History
Getting Started
Files To Be Included With Your Application
Document Writers – Files To Be Included With Your Application
LEADTOOLS Raster Imaging Features
Quick Reference
Tutorials
Function References
Callback Functions
Summary of Features
Appendix
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.