JCL Help:GetWindowIcon

From Project JEDI Wiki
Jump to navigationJump to search


Summary

Returns the icon of a window.


Pascal

 function GetWindowIcon(Wnd: THandle; LargeIcon: Boolean): HICON;


Parameters

Parameters Description
Wnd: THandle Handle to the window for which to retrieve an icon.
LargeIcon: Boolean If True the function returns the large icon. If False the function returns the small icon. Note that the dimension of large and small can be retrieved by the GetSystemMetrics API function using the SM_CICON and SM_CSMICON flags respectively (where is either X or Y for the width and height respectively).


Return Value

If the function succeeds it returns a handle to the requested icon, otherwise it returns 0. In case of success you must release the handle by calling the DestroyIcon API function.


Description

Returns a handle to the icon of the specified window.


About

Unit

JclSysInfo


Donator

Petr Vones


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