Ets_Icon_Unreference()
Note: Requires OPNET Development Kit
Abstract
Decrements the reference count for an icon.
Syntax
Ets_Icon_Unreference (icon_ptr, options)
| Argument | Type | Description |
|---|---|---|
icon_ptr |
EtsT_Icon * |
Icon to be unreferenced. |
options |
int |
Unreference options (see Details). |
Return Type
int
The new reference count for the icon; ETSC_ICON_REF_COUNT_UNDEFINED if unsuccessful.
Header
ets_api_icon.h
Details
The icon must be contained in an icon database that supports reference counting.
options must be one of the following:
ETSC_ICON_REF_OPT_NONEETSC_ICON_REF_OPT_NO_DESTROY—do not destroy the icon if the reference count becomes 0
If the reference count becomes 0 as a result of this call and the NO_DESTROY option is not set, the icon is destroyed and icon_ptr will point to invalid memory after the call.
If you use the NO_DESTROY option and the reference count becomes 0, you can later destroy the icon with Ets_Icon_Unreferenced_Destroy().