SSEnumCustomCellType Function
Applies To
fpSpread DLL control
Description
Returns the name of the next custom cell.
Syntax
BOOL SSEnumCustomCellType(HWND hWnd, LPCTSTR lpszPrevName, LPTSTR lpszName, int nLen);
BOOL
TSpread::EnumCustomCellType(LPCTSTR lpszPrevName, LPTSTR lpszName, int nLen);
Parameters
The following parameters are available:
| Parameter | Description |
|---|---|
| hWnd | Window handle of the fpSpread control |
| lpszPrevName | Name of the custom cell from which to start searching for the next custom cell |
| lpszName | Name of the next custom cell |
| nLen | Specifies the maximum number of characters to copy to the lpszName buffer, including the NULL character. If the text exceeds this limit, it is truncated. |
Remarks
This function is applied to the entire workbook, including all sheets in the control.
To find the first custom cell type, call the SSEnumCustomCellType function and set the lpszPrevName parameter to NULL or an empty string. The function then returns the name of the first custom cell as a string in the lpszName parameter. To find subsequent custom cells, set the lpszPrevName parameter to the last custom cell returned by the lpszName parameter. Continue until the SSEnumCustomCellType function returns 0, in which case the lpszName parameter returns an empty string.
The lpszPrevName and lpszName parameters can point to the same or different string buffers.
You can return the length of the next custom cell by calling the SSEnumCustomCellTypeLen function.
Return Value
TRUE if the function completes successfully; FALSE otherwise.
See Also
SSAddCustomCellType, SSEnumCustomCellTypeLen, SSGetCustomCellType, SSRemoveCustomCellType functions
ActiveX Correspondence
EnumCustomFunction method