SSEnumCustomFunction Function

Applies To

fpSpread DLL control

Description

Returns the name of the next custom function.

Syntax

int SSEnumCustomFunction(HWND hWnd, LPCTSTR lpszPrevFunc, LPTSTR lpszFunc, int nFuncLen);

C++

int

TSpread::EnumCustomFunction(LPCTSTR lpszPrevFunc, LPTSTR lpszFunc, int nFuncLen);

Parameters

The following parameters are available:

Parameter	Description
hWnd	Window handle of the fpSpread control
lpszPrevFunc	Name of custom function from which to start searching for next custom function
lpszFunc	Name of the next custom function
nFuncLen	Specifies the maximum number of characters to copy to the lpszFunc 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 function, call the SSEnumCustomFunction function and set the lpszPrevFunc parameter to NULL or an empty string. The function then returns the name of the first custom function as a string in the lpszFunc parameter. To find subsequent custom functions, set the lpszPrevFunc parameter to the last custom function returned by the lpszFunc parameter. Continue until the SSEnumCustomFunction function returns 0, in which case the lpszFunc parameter returns an empty string.

The lpszPrevFunc and lpszFunc parameters can point to the same or different string buffers.

You can return the length of the next custom function by calling the SSEnumCustomFunctionLen function.

Return Value

Length of copied string, not including the terminating NULL character.

ActiveX Correspondence

EnumCustomFunction method