KCML_Icon_Load

Purpose

Convert a Icon format image to a 2 dimenisonal array representing the image.

Definition

DEFSUB 'KCML_Icon_Load(BYREF image$()_KCML_RGBA), BYREF Icon$, Index, BYREF err$) AS Bool

Parameters

image	2 dimensional array representing the image. The array is resized to the size of the image loaded.
Icon	Buffer containing the icon image
Index	Index of the image in the icon (indexed from 1)
err	An error message if the image fails to load

Return

TRUE if the image is loaded

Description

This function takes a Icon format image as a string and the Index of the required image and returns a 2 dimensional string array of RGBA tuples respresenting the image. The icon format image may be loaded from a .ico file. The function returns TRUE if it succceeds, and if it fails the parameter err$ will contain an error message.

See also

Internal KCML Functions, Internally defined structures and Internally defined enumerations and constants.