SetArrayRank Method

Sets the array rank of this data variable.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function SetArrayRank( _
   ByVal dataVariable As UADataVariable, _
   ByVal arrayRank As Integer _
) As UADataVariable

'Usage
 
Dim dataVariable As UADataVariable
Dim arrayRank As Integer
Dim value As UADataVariable
 
value = UADataVariableExtension.SetArrayRank(dataVariable, arrayRank)

[Extension()]
[NotNull()]
public static UADataVariable SetArrayRank( 
   UADataVariable dataVariable,
   int arrayRank
)

[Extension()]
[NotNull()]
public:
static UADataVariable^ SetArrayRank( 
   UADataVariable^ dataVariable,
   int arrayRank
)

Parameters

dataVariable: The data variable that will be modified and returned.
The value of this parameter cannot be null (Nothing in Visual Basic).
arrayRank: The array rank (number of dimensions) of the array (or 0 for scalars).

Return Value

Returns the , internally modified as defined by the method.

This method never returns null (Nothing in Visual Basic).

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.ArgumentOutOfRangeException	The value of an argument is outside the allowable range of values as defined by the invoked method. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ArgumentOutOfRangeException

The value of an argument is outside the allowable range of values as defined by the invoked method.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

This method allows for the configuration of the variable as an array with specified rank.

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

UADataVariableExtension Class
UADataVariableExtension Members
ArrayDimensions Property

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.