AddIcon2 method

Adds a custom icon with two sizes to the list of available icons for the Facility.

Syntax

C++

HRESULT AddIcon2(

   BSTR LargeFilePath,

   BSTR SmallFilePath,

   IERUIcon** ppIcon)

Scripting languages

Set Icon = Object.AddIcon2(

   LargeFilePath as String,

   SmallFilePath as String)

Parameters

LargeFilePath

The full path of the large version of the icon to add to the Facility.

SmallFilePath

The full path of the small version of the icon to add to the Facility.

ppIcon

Upon return, an IERUIcon interface pointer to the newly-added icon.

Return value

C++

The return code.

Scripting languages

An IERUIcon interface pointer to the newly added icon.

Remarks

The files you specify with LargeFilePath and SmallFilePath must be a .gif file only.

When you add an icon by specifying its full path (for example, c:\icon1.gif), the IERUIcon::FileName property renames the file and returns it as a relative path (such as facilityname//lgcustom1.gif).

Home

Applies to
IERUFacility