SftTabs/DLL 6.5 - Tab Control

GetTabInfo

Retrieves tab attributes.

C

BOOL SftTabs_GetTabInfo(HWND hwndCtl, int iTab, LPSFTTABS_TAB lpTab);

C++

BOOL CSftTabs::GetTabInfo(int iTab, LPSFTTABS_TAB lpTab) const;

Parameters

hwndCtl

The window handle of the tab control.

lpTab

A pointer to a SFTTABS_TAB structure. This structure will be updated with the specified tab's attributes.

Returns

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

Comments

The GetTabInfo function retrieves tab attributes.

Some of the structure values returned can be modified and updated using SetTabInfo. See SFTTABS_TAB for more information.

The function SftTabs_GetTabInfoEx and the LPSFTTABS_TAB_EX lpTabEx parameter of the GetTabInfo function are no longer available (see "Upgrading from Version 4.0").

Example

This example retrieves the tab attributes for the third tab and modifies the background color:

C

SFTTABS_TAB Tab;
SftTabs_GetTabInfo(hwndTab, 2, &Tab); 
Tab.colorBg = RGB(255, 0, 0); 
SftTabs_SetTabInfo(hwndTab, 2, &Tab);

C++

SFTTABS_TAB Tab;
m_Tab.GetTabInfo(2, &Tab); 
Tab.colorBg = RGB(255, 0, 0); 
m_Tab.SetTabInfo(2, &Tab);

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