AddCustomFunctionExt Method
Applies To
fpSpread control
Description
Defines a custom function with a variable number of parameters.
Syntax
BOOL CSpreadSheet::AddCustomFunctionExt(LPCTSTR FunctionName, short MinParamCnt, short MaxParamCnt, long Flags);
fpSpread.AddCustomFunctionExt(ByVal FunctionName As String, ByVal MinParamCnt As Integer, ByVal MaxParamCnt As Integer, ByVal Flags As Long) As Boolean
Parameters
The following parameters are available:
| Parameter | Description | ||
|---|---|---|---|
| FunctionName | Name of the custom function | ||
| MinParamCnt | Minimum number of parameters required by the function | ||
| MaxParamCnt | Maximum number of parameters required by the function | ||
| Flags | Requests references instead of cell values Combine either of the following values with the Or operator: |
||
| Return Value | Value | Description | |
| 0 | CustomFunctionFlagsNone | Function does not want references | |
| 1 | CustomFunctionFlagsWantCellRef | Function receives cell references | |
| 2 | CustomFunctionFlagsWantRangeRef | Function receives range references | |
Remarks
An application must respond to the CustomFunction event to implement the custom function.
This method is applied to the entire workbook, including all sheets in the control.
Return Type
True if successful; otherwise, False.
See Also
Creating and Using Custom Functions
CustomFunction event
AddCustomFunction, CFGetCellParam, CFGetDoubleParam, CFGetDoubleParamExt, CFGetLongParam, CFGetParamInfo, CFGetRangeParam, CFGetStringParam, CFSetResult, EnumCustomFunction, GetCustomFunction, RemoveCustomFunction methods
DLL Correspondence
SSAddCustomFunctionExt function