SftTree/DLL 7.5 - Tree Control

RowColText

Defines the row/column header text.

These functions are provided for compatibility with older releases - use RowColHeaderText instead

C

int SftTree_GetRowColText(HWND hwndCtl, LPTSTR lpszBuffer, int cbMax);
int WINAPI SftTree_GetRowColText_A(HWND hwndCtl, LPSTR lpszBuffer, int cbMax);
int WINAPI SftTree_GetRowColText_W(HWND hwndCtl, LPWSTR lpszBuffer, int cbMax);
BOOL SftTree_SetRowColText(HWND hwndCtl, LPCTSTR lpszBuffer);
BOOL WINAPI SftTree_SetRowColText_A(HWND hwndCtl, LPCSTR lpszBuffer);
BOOL WINAPI SftTree_SetRowColText_W(HWND hwndCtl, LPCWSTR lpszBuffer);
int WINAPI SftTreeSplit_GetRowColText(HWND hwndCtl, LPTSTR lpszBuffer, int cbMax);
int WINAPI SftTreeSplit_GetRowColText_A(HWND hwndCtl, LPSTR lpszBuffer, int cbMax);
int WINAPI SftTreeSplit_GetRowColText_W(HWND hwndCtl, LPWSTR lpszBuffer, int cbMax);
BOOL WINAPI SftTreeSplit_SetRowColText(HWND hwndCtl, LPCTSTR lpszBuffer);
BOOL WINAPI SftTreeSplit_SetRowColText_A(HWND hwndCtl, LPCSTR lpszBuffer);
BOOL WINAPI SftTreeSplit_SetRowColText_W(HWND hwndCtl, LPCWSTR lpszBuffer);

C++

void CSftTree::GetRowColText(CString& string) const;
int CSftTree::GetRowColText(LPTSTR lpszBuffer, int cbMax) const;
BOOL CSftTree::SetRowColText(LPCTSTR lpszBuffer);
void CSftTreeSplit::GetRowColText(CString& string) const;
int CSftTreeSplit::GetRowColText(LPTSTR lpszBuffer, int cbMax) const;
BOOL CSftTreeSplit::SetRowColText(LPCTSTR lpszBuffer);

Parameters

hwndCtl

The window handle of the tree control.

lpszBuffer

A pointer to a buffer where the row/column header text will be returned (GetRowColText) or a buffer containing the new row/column header text (SetRowColText).

string

A reference to a CString object, where the row/column header text will be returned.

cbMax

The maximum number of characters to be returned in the buffer pointed to by lpszBuffer, including the terminating '\0'.

Returns

GetRowColText returns the number of characters returned in the buffer, not including the terminating '\0'. If the buffer is too small to receive the complete header text, the text is truncated. -1 is returned if an error occurred.

SetRowColText returns TRUE if the function was successful, otherwise FALSE is returned.

Comments

These functions are provided for compatibility with older releases - use RowColHeaderText instead

The GetRowColText and SetRowColText functions define the row/column header text.

RowColHeaderTextLength can be used to determine the required lpszBuffer size.

Row/column header text may contain multiple lines of text, delimited using cr-lf (\r\n), based on the settings defined using MultilineHeader and it must contain the same or fewer lines of text as defined for all column headers.

The row/column header area is only shown if row headers and column headers are both shown (see SetShowRowHeader and SetShowHeader).

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