2.468 .wsi_usage[enum]

In Microsoft Windows, the .wsi_usage attribute is used to determine the percentage of WSI objects consumed.

Definition

  • Data type

    enum

  • Access

    get

  • changed event

    no

The setup object includes the attribute .wsi_usage on Microsoft Windows, which returns the percentage of WSI objects consumed. This attribute must be indexed with one of the following enum values:

wsiusage_win_gdi: Indicates how many Windows GDI objects are currently being used.
wsiusage_win_gdipeak: Indicates how many Windows GDI objects were consumed at peak usage.
wsiusage_win_user: Indicates how many Windows User objects are currently being used.
wsiusage_win_userpeak: Indicates how many Windows User objects were consumed at peak usage.

Windows GDI objects include bitmaps, fonts, colors, and clipboard areas. Windows User objects primarily consist of Window objects (HWND). It's important to note that many IDM objects are implemented using multiple Window objects. For example, grouping objects typically require two Window objects.

By querying the relative consumption, a critical condition can be detected in an IDM application before a part of the surface element is not displayed or not displayed completely.

Under Qt and Motif, the failure value -1 is returned.

See also

The Command Line Option -IDMwsiusagewarn.