L_GetOverlayCallback

#include "l_bitmap.h"

L_LTFIL_API L_INT L_GetOverlayCallback(ppfnCallback, ppUserData, puFlags)

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

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.