ArrayDimensions Property (UADataVariable)

The size of each dimension of the array value.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<JetBrains.Annotations.NotNullAttribute()>
Public ReadOnly Property ArrayDimensions As Int32Collection

'Usage
 
Dim instance As UADataVariable
Dim value As Int32Collection
 
value = instance.ArrayDimensions

[JetBrains.Annotations.NotNull()]
public Int32Collection ArrayDimensions {get;}

[JetBrains.Annotations.NotNull()]
public:
property Int32Collection^ ArrayDimensions {
   Int32Collection^ get();
}

Property Value

A collection of integers where each integer represents the maximum size of the array in that dimension, or 0 if the maximum is unknown.

The value of this property cannot be null (Nothing in Visual Basic).

Remarks

This property is relevant for variables that hold array values. Each element in the collection represents a dimension of the array, and the value of the element represents the maximum size of the array in that dimension. If the maximum size of certain dimension is unknown, the value of corresponding element is 0.

For scalar variables, this collection is empty.

You can modify the contents of this collection. If you want to replace the whole array dimensions collection, use the UADataVariableExtension.SetArrayDimensions method.

The specified array dimensions will be exposed to OPC UA clients via the OpcLabs.EasyOpc.UA.UAAttributeId.ArrayDimensions attribute. In addition, OPC Wizard will enforce the maximum array bounds automatically (where the specified array dimension is not 0).

This method or property does not throw any exceptions, aside from execution exceptions such as System.Threading.ThreadAbortException or System.OutOfMemoryException.

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

UADataVariable Class
UADataVariable Members
DataTypeId Property
ArrayDimensions Field
SetArrayDimensions Method
ValueRank Property
Variable NodeClass

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.