SftTabs/DLL 6.5 - Tab Control

GetToolTip

Retrieves a tab's ToolTip text.

C

int SftTabs_GetToolTip(HWND hwndCtl, int iTab, LPTSTR lpsz);
int SftTabs_GetToolTip_A(HWND hwndCtl, int iTab, LPSTR lpsz);
int SftTabs_GetToolTip_W(HWND hwndCtl, int iTab, LPWSTR lpsz);

C++

int CSftTabs::GetToolTip(int iTab, LPTSTR lpsz) const;
void CSftTabs::GetToolTip(int iTab, CString& string) const;

Parameters

hwndCtl

The window handle of the tab control.

iTab

The zero-based index of the tab for which information is to be retrieved.

lpsz

A pointer to a buffer where the tab's ToolTip text will be returned.

string

A reference to a CString object, where the tab's ToolTip text will be returned.

Returns

The return value is the number of characters returned in the buffer, not including the terminating '\0'. The buffer must be large enough to receive the complete text. GetToolTipLen can be used to determine the buffer length needed. -1 is returned if an error occurred.

Comments

The GetToolTip function retrieves a tab's ToolTip text.

A tab's ToolTip text can be changed using SetToolTip.

ToolTips for the scroll buttons, Minimize, Restore and Close buttons can be retrieved and defined using GetControlInfo and SetControlInfo.

Example

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

C

TCHAR szBuffer[80]; 
SftTabs_GetToolTip(hwndTab, 1, szBuffer); 

C++

CString str;
m_Tab.GetToolTip(1, str);

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