Ets_Icon_Export()
Note: Requires OPNET Development Kit
Abstract
Saves an icon in an image file.
Syntax
Ets_Icon_Export (export_type, icon_name_str, out_image_path_str)
| Argument | Type | Description |
|---|---|---|
export_type |
EtsT_Image_Export_Type |
format of exported image; one of the symbolic constants given in Table 16 Icon Sub-Package Symbolic Constants |
icon_name_str |
const char * |
name of the icon to export |
out_image_path_str |
const char * |
directory path to use for image file |
Return Type
EtsT_Compcode
EtsC_Compcode_Success if the image was exported; EtsC_Compcode_Failure otherwise.
Header
ets_api_icon.h
Details
This function exports the image of the specified icon into a file of the specified format. The icon must be contained in one of the icon databases specified in the icon_dbs preference.
The export_type argument specifies the file format to be used for the exported image. The possible values are:
EtsC_Image_Export_Type_GIFEtsC_Image_Export_Type_TIFFEtsC_Image_Export_Type_PNG
Any other value passed to the function will result in a recoverable error.