CFGetCellParamExt, ScriptCFGetCellParamExt Methods

Applies To

fpSpread control

Description

Returns the sheet, column, and row coordinates of a cell reference parameter that is being passed into a custom function.

Syntax

C++

void CSpreadSheet::CFGetCellParamExt (short Param, short *Sheet, long* Col, long* Row);

Visual Basic

fpSpread.CFGetCellParam(ByVal Param As Integer, Sheet As Integer, Col As Long, Row As Long)

Note: The ScriptCFGetCellParamExt 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.)
Sheet	Sheet number
Col	Column coordinate of cell reference
Row	Row coordinate of cell reference

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 CFGetCellParam method.

Return Type

Returns the sheet, column and row coordinates in the Sheet, Col and Row parameters.