Footer
Defines a column's footer text.
C
int SftTree_GetFooterCol(HWND hwndCtl, int realCol, LPTSTR lpszBuffer, int cbMax);
int SftTree_GetFooter(HWND hwndCtl, LPTSTR lpszBuffer, int cbMax);
int WINAPI SftTree_GetFooter_W(HWND hwndCtl, LPWSTR lpszBuffer, int cbMax);
int WINAPI SftTree_GetFooter_A(HWND hwndCtl, LPSTR lpszBuffer, int cbMax);
BOOL SftTree_SetFooterCol(HWND hwndCtl, int realCol, LPCTSTR lpszBuffer);
BOOL SftTree_SetFooter(HWND hwndCtl, LPCTSTR lpszBuffer);
BOOL WINAPI SftTree_SetFooter_A(HWND hwndCtl, LPCSTR lpszBuffer);
BOOL WINAPI SftTree_SetFooter_W(HWND hwndCtl, LPCWSTR lpszBuffer);
int SftTreeSplit_GetFooterCol(HWND hwndCtl, int realCol, LPTSTR lpszBuffer, int cbMax);
int SftTreeSplit_GetFooter(HWND hwndCtl, LPTSTR lpszBuffer, int cbMax);
int WINAPI SftTreeSplit_GetFooter_W(HWND hwndCtl, LPWSTR lpszBuffer, int cbMax);
int WINAPI SftTreeSplit_GetFooter_A(HWND hwndCtl, LPSTR lpszBuffer, int cbMax);
BOOL SftTreeSplit_SetFooterCol(HWND hwndCtl, int realCol, LPCTSTR lpszBuffer);
BOOL SftTreeSplit_SetFooter(HWND hwndCtl, LPCTSTR lpszBuffer);
BOOL WINAPI SftTreeSplit_SetFooter_A(HWND hwndCtl, LPCSTR lpszBuffer);
BOOL WINAPI SftTreeSplit_SetFooter_W(HWND hwndCtl, LPCWSTR lpszBuffer);
C++
void CSftTree::GetFooter(int realCol, CString& string) const;
void CSftTree::GetFooter(CString& string) const;
int CSftTree::GetFooter(int realCol, LPTSTR lpszBuffer, int cbMax) const;
int CSftTree::GetFooter(LPTSTR lpszBuffer, int cbMax) const;
BOOL CSftTree::SetFooter(int realCol, LPCTSTR lpszBuffer);
BOOL CSftTree::SetFooter(LPCTSTR lpszBuffer);
void CSftTreeSplit::GetFooter(int realCol, CString& string) const;
void CSftTreeSplit::GetFooter(CString& string) const;
int CSftTreeSplit::GetFooter(int realCol, LPTSTR lpszBuffer, int cbMax) const;
int CSftTreeSplit::GetFooter(LPTSTR lpszBuffer, int cbMax) const;
BOOL CSftTreeSplit::SetFooter(int realCol, LPCTSTR lpszBuffer);
BOOL CSftTreeSplit::SetFooter(LPCTSTR lpszBuffer);
Parameters
hwndCtl
The window handle of the tree control.
realCol
The zero-based column number whose text is to be retrieved or set.
lpszBuffer
A pointer to a buffer where the footer text will be returned (GetFooter) or a buffer containing the new footer text (SetFooter).
string
A reference to a CString object where the footer 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
GetFooter (GetFooterCol) returns the number of characters returned in the buffer, not including the terminating '\0'. If the buffer is too small to receive the complete footer text, the text is truncated. -1 is returned if an error occurred.
SetFooter (SetFooterCol) returns TRUE if the function was successful, otherwise FALSE is returned.
Comments
The GetFooter and SetFooter functions define a column's footer text.
The footer text set or retrieved is based on the column specified using realCol or last defined using SetAccessColumn. Functions, which do not allow the realCol parameter, access the column last defined by SetAccessColumn or the last column referenced by a column specific function. The last column accessed can be retrieved using GetAccessColumn.
Footer text can contain multiple lines of text using cr-lf (\r\n). SetMultilineFooter must be used to enable multiple lines of text. The SetFooter function cannot be used to add more text lines than the footer already contains. When increasing the number of text lines, the SetColumns function must be used instead.
See Also C/C++ API | Categories | Notifications
On
Off