Spread 8.0 Documentation
CFGetDoubleParamExt, ScriptCFGetDoubleParamExt Methods
Support Options
ActiveX Reference > ActiveX Methods > CFGetDoubleParamExt, ScriptCFGetDoubleParamExt Methods

Glossary Item Box

CFGetDoubleParamExt, ScriptCFGetDoubleParamExt Methods


See Also

Applies To

fpSpread control

Description

Returns a custom function's parameter as a double-precision, floating-point value. Borland C++ users must use this method instead of the CFGetDoubleParam method.

Syntax

C++

double CSpreadSheet::CFGetDoubleParamExt (short Param, double* ParamValue);

Visual Basic

fpSpread.CFGetDoubleParamExt(ByVal Param As Integer, ParamValue As Double) As Double

Note: The ScriptCFGetDoubleParamExt 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
Param Index number of the parameter
(The index of the first parameter is 1.)
ParamValue Value of the specified parameter

Remarks

This method can only be used inside the CustomFunction event handler.

You must use the CFGetParamInfo method to check the parameter status and type before calling the CFGetDoubleParamExt method.

This method is called for the current sheet setting unless you first set the Sheet property to specify the sheet with which you want to work.

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 ScriptCFGetDoubleParamExt method. ScriptCFGetDoubleParamExt method parameters that are not passed "ByVal" are declared as variants.

Return Type

Value of the specified parameter

See Also

Creating and Using Custom Functions

Sheet property

CustomFunction event

AddCustomFunction, AddCustomFunctionExt, CFGetCellParam, CFGetDoubleParam, CFGetLongParam, CFGetParamInfo, CFGetRangeParam, CFGetStringParam, CFSetResult, EnumCustomFunction, GetCustomFunction, RemoveCustomFunction methods

ScriptEnhanced property

© 2002-2014 ComponentOne, a division of GrapeCity. All Rights Reserved.