Spread 8.0 Documentation
CFGetLongParam Method
Support Options
ActiveX Reference > ActiveX Methods > CFGetLongParam Method

Glossary Item Box

CFGetLongParam Method


See Also    Example

Applies To

fpSpread control

Description

Returns a custom function's parameter as a long integer value.

Syntax

C++

long CSpreadSheet::CFGetLongParam (short Param);

Visual Basic

fpSpread.CFGetLongParam(ByVal Param As Integer) As Long

Parameters

The following parameter is available:

Parameter Description
Param Index number of the parameter
(The index of the first parameter is 1.)

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 CFGetLongParam 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.

Return Type

Value of the specified parameter

See Also

Creating and Using Custom Functions

Sheet property

CustomFunction event

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

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