ITfLangBarItemBitmapButton::GetPreferredSize method (ctfutb.h)

Article
11/19/2022

Obtains the preferred size, in pixels, of the bitmap.

Syntax

HRESULT GetPreferredSize(
  [in]  const SIZE *pszDefault,
  [out] SIZE       *psz
);

Parameters

[in] pszDefault

Pointer to a SIZE structure that contains the default size, in pixels, of the bitmap.

[out] psz

Pointer to a SIZE structure that receives the preferred size, in pixels, of the bitmap. The cy member of this structure is ignored.

Return value

This method can return one of these values.

Value	Description
S_OK	The method was successful.

Remarks

The results of this method are not currently used. The bitmap for a bitmap button item should not be larger than the size of a small icon. Obtain these dimensions by calling GetSystemMetrics with SM_CXSMICON for the width and SM_CYSMICON for the height.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	ctfutb.h
DLL	Msctf.dll
Redistributable	TSF 1.0 on Windows 2000 Professional