CFGetParamInfo, ScriptCFGetParamInfo Methods

Applies To

fpSpread control

Description

Returns information about a custom function's parameter.

Syntax

C++

BOOL CSpreadSheet::CFGetParamInfo (short Param, long* Type, long* Status);

Visual Basic

fpSpread.CFGetParamInfo(ByVal Param As Integer, Type As Long, Status As Long) As Boolean

Note: The ScriptCFGetParamInfo 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.)
Type	Data type of the parameter One of the following:
	Constant	Value	Description
	ValueTypeLong	0	Long
	ValueTypeDouble	1	Double
	ValueTypeString	2	String
	ValueTypeCellRef	3	Cell reference
	ValueTypeRangeRef	4	Range reference
Status	Status of the parameter One of the following:
	Constant	Value	Description
	ValueStatusOK	0	Value is valid
	ValueStatusError	1	An error occurred (Probably the wrong data type)
	ValueStatusEmpty	2	Parameter is empty

Remarks

This method is valid only within the CustomFunction event.

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

Return Type

True if successful; otherwise, False.