SpreadsheetGear 2017
Evaluate Method (Function)






SpreadsheetGear.CustomFunctions Namespace > Function Class : Evaluate Method
Provides access to the arguments to this custom function. Note that using the IArguments indexer has the side effect of converting a range reference or array to a simple value (use GetArrayDimensions and GetArrayValue to get individual values from a range or array).
Assign the result of the custom function to result. The value of result is undefined until set by the Evaluate method.
Evaluates a custom function with the specified arguments. See the remarks in the help for this method for a number of rules which must be taken into account.
Syntax
'Declaration
 
Public MustOverride Sub Evaluate( _
   ByVal arguments As IArguments, _
   ByVal result As IValue _
) 
'Usage
 
Dim instance As Function
Dim arguments As IArguments
Dim result As IValue
 
instance.Evaluate(arguments, result)
public abstract void Evaluate( 
   IArguments arguments,
   IValue result
)
public procedure Evaluate( 
    arguments: IArguments;
    result: IValue
); abstract; 
public __abstract function Evaluate( 
   arguments : IArguments,
   result : IValue
);
public: abstract void Evaluate( 
   IArguments* arguments,
   IValue* result
) 
public:
abstract void Evaluate( 
   IArguments^ arguments,
   IValue^ result
) 

Parameters

arguments
Provides access to the arguments to this custom function. Note that using the IArguments indexer has the side effect of converting a range reference or array to a simple value (use GetArrayDimensions and GetArrayValue to get individual values from a range or array).
result
Assign the result of the custom function to result. The value of result is undefined until set by the Evaluate method.
Remarks

The implementation of this method must follow a number of rules:

If an exception is thrown during custom function evaluation, the custom function will return ValueError.Name.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

Function Class
Function Members