SpreadsheetGear.CustomFunctions Namespace > IArguments Interface : GetNumber Method |
'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 )
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.
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