formZ SDK | 4.0 Call Back Reference | Command | Project Command

# fz_cmnd_cbak_proj_icon_file_obsolete

Description

Command icon from file (Optional). This function is called by formZ to load an icon for the command from an image file. The image file can be in any supported image file format (or of an image format wich is support be a image file translator plugin). It is recommened to use the TIFF image format as it is a cross platform supported format and is always present. The source graphics are identified in the file by indicating the top left corner of the graphic in the file. In addition to the graphic, a mask can be provided for use when the icon is highlighted. A single file can be used for multiple icons across a variety of plugins by createing a grid of icons in the file and specifing the location for each icon.

Plugin Prototype

fzrt_error_td fz_cmnd_cbak_proj_icon_file_obsolete(

fzrt_floc_ptr | floc )

Parameters

floc [Result]

file location of file which contains the icon.

Returns

Error codes

Availability

5.0.0.0

See Also

Function Set

fz_cmnd_cbak_proj_fset

Defined in

fz_cmnd_api.h