SpreadsheetGear 2010
GetNumber Method
See Also  Send Feedback
SpreadsheetGear.CustomFunctions Namespace > IArguments Interface : GetNumber Method

index
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

Visual Basic (Declaration) 
Function GetNumber( _
   ByVal index As Integer _
) As Double
C# 
double GetNumber( 
   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 SpreadsheetGear.CustomFunctions.IArguments.GetArrayDimensions and SpreadsheetGear.CustomFunctions.IArguments.GetArrayValue to get the dimensions and values of a range or array.

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

Copyright © 2003-2010 SpreadsheetGear LLC. All Rights Reserved.Help Powered by Innovasys   
SpreadsheetGear is a registered trademark of SpreadsheetGear LLC.
Microsoft, Microsoft Excel and Visual Studio are trademarks or registered trademarks of Microsoft Corporation.