JCL Help:OverlayIcon

 JCL Help: OverlayIcon Function

Windows_Specific.Shell.Miscellaneous

JEDI Code Library Help

• Packages
  • RTL enhancements
  • Containers
  • Developer Tools
  • VCL enhancements
• Files
  • Classes
  • Interfaces
  • Functions
  • Variables
  • Constants
  • Types
  • Records
• Project summary
• License

Search in JCL Help

 

Search in all projects

 

Summary

Overlays Icon with OverlayIcon.

Pascal

 function OverlayIcon(var Icon: HICON; Overlay: HICON; Large: Boolean): Boolean;

Parameters

Parameters	Description
var Icon: HICON	Handle of the icon which you want to overlay.
Overlay: HICON	Handle of the overlay icon.
Large: Boolean	If True Icon and Overlay are assumed to be large icons, if False they are assumed to be small icons. See Notes.

Return Value

If the function succeeds the result is True and Icon contains a handle to the overlayed version. If the function fails the return value is False.

Description

OverlayIcon will overlay Icon with Overlay and return the result in Icon. If the function succeeds the return value is True. If it fails the return value is False in which case Icon retains its old value. The Large parameter controls whether the icons are assumed to be large (True) or small (False).

See Also

OverlayIconShortcut OverlayIconShared

About

Unit

JclShell

Donator

Marcel van Brakel

Notes

The dimensions of large and small are determined by using the GetSystemMetrics function with SM_CXICON, SM_CXSMICON respectively.

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page

The JEDI Code Library source code is hosted at : link to view the current source code, link to the subversion repository