Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

hiSaveIconData

hiSaveIconData(
l_hiIcon
t_fileName
[ t_formatName ]
)
=> t / nil

Description

Saves a loaded pixmap to a file in the specified format. This function accepts an hi pixmap description and converts it to any of the image formats supported by Qt; currently, these are: BMP, JPG, PNG, PPM, XBM, and XPM. However, PNG is the recommended format.

Arguments

l_hiIcon

The pixmap handle, which is the return value of hiStringToIcon or hiLoadIconData.

t_fileName

The name of the file to which you want to save the pixmap.

t_formatName

The format in which you want to save the pixmap.

Values Returned

t

The pixmap was saved in the format you specified.

nil

There was an error.

Examples

Saves a loaded pixmap by the name legacy.png in the png format.

hiSaveIconData ( legacyPixmap "legacy.png" "png" )

Related Topics

Icon Functions

hiStringToIcon

hiLoadIconFile

hiLoadImageFile

hiLoadIconData

hiSaveIconData

hiStringToIcon

hiMatchColorByName


Return to top
 ⠀
X