SpreadsheetGear 2023
GetLogical Method (IArguments)


SpreadsheetGear.CustomFunctions Namespace > IArguments Interface : GetLogical Method
Returns the argument specified by the zero based index as a logical (boolean) value. Note that this method has the side effect of converting a range or array to a single value.
Syntax
'Declaration
 
Function GetLogical( _
   ByVal index As System.Integer _
) As System.Boolean
'Usage
 
Dim instance As IArguments
Dim index As System.Integer
Dim value As System.Boolean
 
value = instance.GetLogical(index)
System.bool GetLogical( 
   System.int index
)

Parameters

index
Remarks

Non-logical arguments are converted to a logical value if possible. Otherwise, false 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
GetNumber Method
GetText Method