EnumCustomFunction, ScriptEnumCustomFunction Methods

Applies To

fpSpread control

Description

Returns the name of the next custom function.

Syntax

C++

BOOL CSpreadSheet::EnumCustomFunction(LPCTSTR PrevFuncName, BSTR* FuncName);

Visual Basic

fpSpread.EnumCustomFunction(ByVal PrevFuncName As String, FuncName As String) As Boolean

Note: The ScriptEnumCustomFunction method uses the same syntax except method parameters that are not passed "ByVal" are declared as variants. For more information on Script methods, see Scripting Environment Usage.

Parameters

The following parameters are available:

Parameter	Description
PrevFuncName	Name of custom function from which to start searching for next custom function
FuncName	Name of the next custom function

Remarks

To find the first custom function, call the EnumCustomFunction method and set the PrevFuncName parameter to an empty string. The method then returns the name of the first custom function as a string in the FuncName parameter. To find subsequent custom functions, set the PrevFuncName parameter to the last custom function returned by the FuncName parameter. Continue until the EnumCustomFunction method returns False, in which case the FuncName parameter returns an empty string.

Note: Call this method if you use the Spread control in a scripting environment (for example, Microsoft's Visual InterDev or Internet Explorer) or a non-scripting environment. However, if you want to use the Spread control in a scripting environment and you want to change any parameter that is not passed "ByVal", you must set the ScriptEnhanced property to True and call the ScriptEnumCustomFunction method. ScriptEnumCustomFunction method parameters that are not passed "ByVal" are declared as variants.

This method returns information for the entire workbook, including all sheets in the control.

Return Type

True if successful; otherwise, False.

DLL Correspondence

SSEnumCustomFunction, SSEnumCustomFunctionLen functions