SSQueryCustomName Function
Applies To
fpSpread DLL control
Description
Returns a defined custom name.
Syntax
int SSQueryCustomName(HWND hWnd, LPCTSTR lpszPrevName, LPTSTR lpszName, int nNameLen);
int TSpread::QueryCustomName(LPCTSTR lpszPrevName, LPTSTR lpszName, int nNameLen);
Parameters
The following parameters are available:
| Parameter | Description |
|---|---|
| hWnd | Window handle of the fpSpread control |
| lpszPrevName | Pointer to the previous custom name |
| lpszName | Custom name returned by the function |
| nNameLen | Length of custom name |
Remarks
This function is applied to the entire workbook, including all sheets in the control.
This function returns the names of the defined custom names in the lpszName parameter.
You can define custom names to represent information in the control. For example, a custom name can represent a cell, a cell range, or a computed value. Use the SSSetCustomName function to define a custom name that can then be used in formulas. The name can be up to 255 characters long.
To retrieve the first custom name, provide a NULL value for the lpszPrevName parameter.
Return Value
A nonzero value returns length of the name retrieved; a zero value indicates no name was retrieved.
See Also
SSGetCustomName, SSGetCustomNameLen, SSQueryCustomNameLen, SSSetCustomName functions
ActiveX Correspondence
QueryCustomName method