KCML_Icon_GetImages

Purpose

Return a list of images in an icon format image.

Definition

DEFSUB 'KCML_Icon_GetImages(BYREF image$()_KCML_ICON_INFO), BYREF Icon$, BYREF err$) AS Bool

Parameters

image	Array of information about images within the icon. For each image it returns the width, height and number of bits per pixel. The array is resized to the number of the images in the icon.
Icon	Buffer containing the icon image.
err	An error message if the icon fails to load.

Return

TRUE if the icon is loaded

Description

This function takes a Icon format image as a string and returns an array of images in the icon. 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.