Method XbpIcon():loadFile() Foundation

Loads an icon file from disk

Syntax
:loadFile( <cFilename>, [<nWidth>], [<nHeight>] ) --> lSuccess
Parameters
<cFilename>
<cFilename> is a character string containing the name of an icon file to be loaded.
<nWidth>
The optional parameter <nWidth> contains a numerical value that specifies the width of the icon to load. If images of several sizes are defined in the icon file, the image whose width most closely matches that in <nWidth>is selected. If the icon file contains only a single image, the image is scaled to match the width requested. Parameter <nWidth> defaults to 32.
<nHeight>
The optional parameter <nHeight> contains a numerical value that specifies the height of the icon to load. If images of several sizes are defined in the icon file, the image whose height most closely matches that in <nHeight>is selected. If the icon file contains only a single image, the image is scaled to match the height requested. Parameter <nHeight> defaults to 32.
Return

This method returns .T. (true) when the icon could be loaded, otherwise it returns .F. (false).

Description

The :loadFile() method loads an icon that is not linked as a resource to the executable file but is stored in an external icon file.

Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.