SSGetSheetName, SSSetSheetName Functions
Applies To
fpSpread DLL control
Description
Set or return a string as the sheet name for the specified sheet.
Syntax
short SSGetSheetName(HWND hWnd, short nSheet, LPTSTR lpszName, short nLen);
BOOL SSSetSheetName(HWND hWnd, short nSheet, LPCTSTR lpszSheetName);
short TSpread::GetSheetName(short nSheet, LPTSTR lpszName, short nLen);
BOOL TSpread::SetSheetName(short nSheet, LPCTSTR lpszSheetName);
Parameters
The SSGetSheetName function has the following parameters:
Parameter | Description |
---|---|
hWnd | Window handle of the fpSpread control |
nSheet | Sheet index of name to return |
lpszName | Name of the sheet |
nLen | Maximum length of the buffer that will contain the value |
The SSSetSheetName function has the following parameters:
Parameter | Description |
hWnd | Window handle of the fpSpread control |
nSheet | Sheet index for which to set name |
lpszSheetName | Name for the specified sheet |
Remarks
The sheet name provides another way to access specific sheets, and it is the text displayed in the corresponding sheet tab in the tab strip.
SSSetSheetName will only display the first 30 characters.
Return Value
SSGetSheetName: Length of specified sheet name.
SSSetSheetName: TRUE if the function completes successfully; FALSE otherwise.
See Also
SSGetSheet, SSGetSheetCount, SSSetSheet, SSSetSheetCount functions
ActiveX Correspondence
SheetName property