L_GetOverlayCount

Summary

Gets the number of overlays that have been defined for the specified main bitmap.

Syntax

#include "l_bitmap.h"

L_LTKRN_API L_INT L_GetOverlayCount (pBitmap, puCount, uFlags)

Parameters

pBITMAPHANDLE pBitmap

Pointer to the bitmap handle referencing the main bitmap.

L_UINT *puCount

Pointer to a variable to be updated with the number of overlays.

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

This function will count how many overlays have been defined. The overlays are defined by calling L_SetOverlayBitmap or L_SetOverlayAttributes.

Required DLLs and Libraries

Platforms

Win32, x64, Linux.

See Also

Functions

Topics

Example

This example will return the count of the overlays from pBitmap. 

L_INT  GetOverlayCountExample(pBITMAPHANDLE pBitmap) 
{ 
   L_INT nRet; 
   L_UINT uCount; 
 
   nRet  = L_GetOverlayCount(pBitmap, &uCount, 0);  
   if(nRet != SUCCESS) 
      return nRet; 
 
   /* now uCount contains the number of overlays */ 
   return SUCCESS ; 
}

Help Version 22.0.2023.7.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 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.