Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter NineDialog Functions (continued)

DialogSetIcon Function

Overview

The DialogSetIcon function sets the icon for the caption of a dialog.

Syntax/Parameters

Syntax

int = DialogSetIcon ( string name | handle hIcon );

Parameters

name

A string specifying a filename or resource name for an icon. Or,

hIcon

A handle to a Resource Object containing an Icon.

Return Value

Returns an int value as ERROR_NONE or a formatted error code. Use the GetLastError function to retrieve error information.

Remarks

For the icon to show, the dialog must have the dialog caption style bits WS_CAPTION and WS_SYSMENU set.

The icon needs to have a 16x16 version available for placement.

If created on the fly, the icon resource is released with the dialog box is closed.

See also section Section 9.8 Image Resources.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic