SpreadsheetGear 2017
GetNumber Method (IArguments)






SpreadsheetGear.CustomFunctions Namespace > IArguments Interface : GetNumber Method
Returns the argument specified by the zero based index as a double precision floating point number. Note that this method has the side effect of converting a range or array to a single value.
Syntax
'Declaration
 
Function GetNumber( _
   ByVal index As System.Integer _
) As System.Double
'Usage
 
Dim instance As IArguments
Dim index As System.Integer
Dim value As System.Double
 
value = instance.GetNumber(index)
System.double GetNumber( 
   System.int index
)
function GetNumber( 
    index: System.Integer
): System.Double; 
function GetNumber( 
   index : System.int
) : System.double;
System.double GetNumber( 
   System.int index
) 
System.double GetNumber( 
   System.int index
) 

Parameters

index
Remarks

Non-numeric arguments are converted to a number if possible. Otherwise, 0.0 is returned by this method, and an internal flag is set indicating that an error has occurred, causing the result of the formula to be an error.

Note that this method has the side effect of converting a range or array to a single value. Use IArguments.GetArrayDimensions and IArguments.GetArrayValue to get the dimensions and values of a range or array.

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

IArguments Interface
IArguments Members
Indexer
GetArrayDimensions Method
GetArrayValue Method
GetLogical Method
GetText Method