ITfLangBarItemButton::GetIcon method (ctfutb.h)
Obtains the icon to be displayed for the language bar button.
Syntax
HRESULT GetIcon(
[out] HICON *phIcon
);
Parameters
[out] phIcon
Pointer to an HICON value that receives the icon handle. Receives NULL if the button has no icon. The caller must free this icon when it is no longer required by calling DestroyIcon.
Return value
This method can return one of these values.
| Value | Description |
|---|---|
|
The method was successful. |
|
phIcon is invalid. |
Remarks
The ideal size of the icon can be obtained by calling GetSystemMetrics(SM_CXSMICON) for the icon width and GetSystemMetrics(SM_CYSMICON) for the icon height.
If the button has the TF_LBI_STYLE_TEXTCOLORICON style, the icon obtained by this method should be a monochrome icon.
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 |