Sets a tab's ToolTip text.

C

BOOL SftTabs_SetToolTip(HWND hwndCtl, int iTab, LPCTSTR lpsz);
BOOL SftTabs_SetToolTip_A(HWND hwndCtl, int iTab, LPCSTR lpsz);
BOOL SftTabs_SetToolTip_W(HWND hwndCtl, int iTab, LPCWSTR lpsz);

C++

BOOL CSftTabs::SetToolTip(int iTab, LPCTSTR lpsz);

Parameters

hwndCtl

The window handle of the tab control.

iTab

The zero-based index of the tab for which the ToolTip text is to be set.

lpsz

A pointer to a null-terminated buffer containing the tab's ToolTip text.

Returns

The return value is TRUE if the function was successful, otherwise FALSE is returned.

Comments

The SetToolTip function sets a tab's ToolTip text.

The tab control creates a copy of the string supplied.

A tab's text can be retrieved using GetToolTip.

Example

This example sets the text of the second tab's ToolTip:

C

SftTabs_SetToolTip(hwndTab, 1, "New Text"); 

C++

m_Tab.SetToolTip(1, "New Text");

See Also  C/C++ API  |  C++ Classes  |  Notifications