ICONMETRICSA structure (winuser.h)

Contains the scalable metrics associated with icons. This structure is used with the SystemParametersInfo function when the SPI_GETICONMETRICS or SPI_SETICONMETRICS action is specified.

Syntax

typedef struct tagICONMETRICSA {
  UINT     cbSize;
  int      iHorzSpacing;
  int      iVertSpacing;
  int      iTitleWrap;
  LOGFONTA lfFont;
} ICONMETRICSA, *PICONMETRICSA, *LPICONMETRICSA;

Members

cbSize

Type: UINT

The size of the structure, in bytes.

iHorzSpacing

Type: int

The horizontal space, in pixels, for each arranged icon.

iVertSpacing

Type: int

The vertical space, in pixels, for each arranged icon.

iTitleWrap

Type: int

If this member is nonzero, icon titles wrap to a new line. If this member is zero, titles do not wrap.

lfFont

Type: LOGFONT

The font to use for icon titles.

Remarks

Note

The winuser.h header defines ICONMETRICS as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	winuser.h (include Windows.h)

See also

Conceptual

Icons

Other Resources

SystemParametersInfo