formZ SDK | 5.0 API Reference | System | Runtime Library (FZRT) | Basic

# fzrt_rlib_load_icon

Description

Loads an icon resource from a runtime module. This will load an icon from the runtime module. If the icon resource cannot be loaded, the icon_ptr is set to NULL. The icons need to be saved in the resource of the runtime module (dll, shared library). NOTE: On Macintosh, black and white icons are stored as an ICON resource, and color icons are stored as a CICN resource. On Windows, black and white icons are 1 bit deep bitmaps and must be stored as a "FZICON" resource, color icons can be either a Windows native BITMAP or ICON resource. If the color icon is stored as a BITMAP resource, it will not have a mask associated with it.

Plugin Prototype

fzrt_error_td fzrt_rlib_load_icon(

short | rlib_indx,
fzrt_icon_enum | icon_type,
short | resID,
fzrt_icon_ptr * | icon_ptr )

Parameters

rlib_indx [Input]

reference to the loaded module

icon_type [Input]

type of icon FZRT_LOAD_ICON_COLOR, FZRT_LOAD_ICON_BW

resID [Input]

ID of the resource to load

icon_ptr [Result]

pointer to an icon_ptr that receives the loaded icon

Returns

FZRT_NOERR on success, error code otherwise.

Availability

5.0.0.0

Function Set

fz_fzrt_base_fset

Defined in

fzrt_api.h