ValidateDimensions(Boolean,Int32Collection,Int32) Method

Validate the dimensions of a given matrix. As a side effect will bring to 0 negative dimensions. Throws ArgumentException if dimensions overflow and ServiceResultException if maxArrayLength is exceeded

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Overloads Shared Function ValidateDimensions( _
   ByVal allowZeroDimension As Boolean, _
   ByVal dimensions As Int32Collection, _
   ByVal maxArrayLength As Integer _
) As ValueTuple(Of Boolean,Integer)

'Usage
 
Dim allowZeroDimension As Boolean
Dim dimensions As Int32Collection
Dim maxArrayLength As Integer
Dim value As ValueTuple(Of Boolean,Integer)
 
value = Matrix.ValidateDimensions(allowZeroDimension, dimensions, maxArrayLength)

public static ValueTuple<bool,int> ValidateDimensions( 
   bool allowZeroDimension,
   Int32Collection dimensions,
   int maxArrayLength
)

public:
static ValueTuple<bool,int> ValidateDimensions( 
   bool allowZeroDimension,
   Int32Collection^ dimensions,
   int maxArrayLength
)

Parameters

allowZeroDimension: Allow zero value dimensions
dimensions: Dimensions to be validated
maxArrayLength: The limit representing the maximum array length

Return Value

Tuple with validation result and the calculated length of the flattended matrix

Exceptions

Exception	Description
System.ArgumentException	The exception that is thrown when one of the arguments provided to a method is not valid.
ServiceResultException	An exception thrown when a UA defined error occurs.

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

Reference

Matrix Class
Matrix Members
Overload List