SftTree/DLL 7.5 - Tree Control

AccessColumn

Defines the current column accessed by column specific functions.

C

int WINAPI SftTree_GetAccessColumn(HWND hwndCtl);
int WINAPI SftTree_SetAccessColumn(HWND hwndCtl, int realCol);
int WINAPI SftTreeSplit_GetAccessColumn(HWND hwndCtl);
int WINAPI SftTreeSplit_SetAccessColumn(HWND hwndCtl, int realCol);

C++

int CSftTree::GetAccessColumn() const;
int CSftTree::SetAccessColumn(int realCol = 0);
int CSftTreeSplit::GetAccessColumn() const;
int CSftTreeSplit::SetAccessColumn(int realCol = 0);

Parameters

hwndCtl

The window handle of the tree control.

realCol

The zero-based column number to become the current column.

Returns

GetAccessColumn returns the zero-based column number of the current column being accessed by column specific messages/functions.

SetAccessColumn returns the column being accessed before the new current column is defined. -1 is returned if an error occurred.

Comments

GetAccessColumn and SetAccessColumn are provided for compatibility with SftTree 1.0 only. Applications should use the new form of functions that supports a column number argument.

The GetAccessColumn function returns the current column accessed by column specific functions.

The SetAccessColumn function sets the current column accessed by column specific functions.

The following functions access the current column when the column number is not explicitly specified:

FindString, FindStringExact, GetHeader, GetHeaderLen, GetText, GetTextLen, SelectString, SelectStringExact, SetHeader, SetText, SortDependents.

When a tree control is created, the current column is column 0.

The column number returned or set by this function remains in effect until changed by a call to SetAccessColumn or any other function where a column number is explicitly specified.

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